README.md

Docs4NIST Action

This is a GitHub action that uses sphinx to build documentation and then host on https://pages.nist.gov as an approximation of ReadTheDocs.

Usage

• Configure your repo for publishing on pages.nist.gov

• Create 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/[email protected]
          with:
            docs-folder: docs/
            formats: |-
              epub
              pdf

Note: GitHub Actions' YAML implementation does not support list or array elements, so use a multiline string to declare formats, as illustrated above.

The self-generated documentation for this action is available at https://pages.nist.gov/Docs4NIST.