Skip to content

clarify parameter name description and units #125

clarify parameter name description and units

clarify parameter name description and units #125

Workflow file for this run

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 pygments==2.14.0
pip install sphinx==4.4.0
pip install sphinx_rtd_theme==1.1.1
pip install sphinx-tabs==3.4.0
pip install sphinx-notfound-page==0.8.3
pip install sphinxext-opengraph==0.7.5
- name: Sphinx build
run: |
cd doc
make html
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./doc/build/html/
force_orphan: true