Updated some docstring for parameters. #47
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
| name: Docs | |
| on: [ push, pull_request, workflow_dispatch ] | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: actions/setup-python@v2 | |
| - name: Install dependencies | |
| run: | | |
| pip install sphinx sphinx_rtd_theme sphinx-copybutton | |
| pip install -r docs/requirements.txt | |
| - name: Sphinx build | |
| run: | | |
| sphinx-build docs/source docs/_build | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: ${{ github.event_name == 'push' }} | |
| with: | |
| publish_branch: gh-pages | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/_build/ | |
| force_orphan: true |