NISTtheDocs2Death
¶
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¶
For each branch of your repository where you want to host documentation, add a workflow, such as
.github/workflows/NISTtheDocs2Death.yml
:
name: "Build Documentation"
on: [push, pull_request, delete]
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: usnistgov/NISTtheDocs2Death@0.2
with:
docs-folder: docs/
formats: |-
epub
pdf
Contents: