`Docs4NIST`¶

This GitHub action [1] uses the Sphinx tool to build documentation in https://github.com/usnistgov projects and then host that documentation on https://pages.nist.gov, as an approximation of ReadTheDocs.

Usage¶

Configure your repo for publishing on pages.nist.gov.
Enable GitHub Actions for your repo and select “Allow all actions and reusable workflows” (you may need to submit a request to devops@nist.gov to enable this for you).
For each branch of your repository where you want to host documentation, add a workflow, such as .github/workflows/Docs4NIST.yml:

name: "Build Documentation"

on: [push, pull_request, delete]

jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: usnistgov/Docs4NIST@0.6
        with:
          docs-folder: docs/
          formats: |-
            epub
            pdf

See Docs4NIST Action for more information about configuration of this workflow.

Indices and tables¶