This is a GitHub action that uses sphinx to build documentation and then host on https://pages.nist.gov as an approximation of ReadTheDocs.
-
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/Docs4NIST@0.7 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.