docs: adds frontend guide first draft #2842
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # This Software (Dioptra) is being made available as a public service by the | |
| # National Institute of Standards and Technology (NIST), an Agency of the United | |
| # States Department of Commerce. This software was developed in part by employees of | |
| # NIST and in part by NIST contractors. Copyright in portions of this software that | |
| # were developed by NIST contractors has been licensed or assigned to NIST. Pursuant | |
| # to Title 17 United States Code Section 105, works of NIST employees are not | |
| # subject to copyright protection in the United States. However, NIST may hold | |
| # international copyright in software created by its employees and domestic | |
| # copyright (or licensing rights) in portions of software that were assigned or | |
| # licensed to NIST. To the extent that NIST holds copyright in this software, it is | |
| # being made available under the Creative Commons Attribution 4.0 International | |
| # license (CC BY 4.0). The disclaimers of the CC BY 4.0 license apply to all parts | |
| # of the software developed or licensed by NIST. | |
| # | |
| # ACCESS THE FULL CC BY 4.0 LICENSE HERE: | |
| # https://creativecommons.org/licenses/by/4.0/legalcode | |
| name: Sphinx documentation | |
| on: | |
| push: | |
| branches: | |
| - "**" | |
| tags: | |
| - "*.*.*" | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: setup python 3.11 | |
| uses: actions/[email protected] | |
| with: | |
| python-version: "3.11" | |
| - name: upgrade pip | |
| run: | | |
| # install pip=>20.1 to use "pip cache dir" | |
| python3 -m pip install --upgrade pip | |
| - name: get pip cache dir | |
| id: pip-cache | |
| run: echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT | |
| - name: cache dependencies | |
| uses: actions/[email protected] | |
| with: | |
| path: ${{ steps.pip-cache.outputs.dir }} | |
| key: ${{ runner.os }}-pip-${{ hashFiles('**/pyproject.toml', '**/tox.ini') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pip- | |
| - name: install dependencies | |
| run: python3 -m pip install tox | |
| - name: build the documentation | |
| run: python3 -m tox run -e docs | |
| - name: archive the documentation | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs-build | |
| path: docs/build | |
| - name: deploy documentation to github pages | |
| uses: peaceiris/actions-gh-pages@v4 | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/build | |
| publish_branch: nist-pages | |
| user_name: "github-actions[bot]" | |
| user_email: "github-actions[bot]@users.noreply.github.com" | |
| commit_message: ${{ github.event.head_commit.message }} |