Skip to content
Deploy Documentation

Modify index.rst #20

Sign in to view logs

Modify index.rst

Modify index.rst #20

Workflow file for this run

.github/workflows/cd.yml at 0070b99
name: Deploy Documentation
on:
push:
branches:
- main
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.11
- name: Install dependencies
run: python -m pip install myst-parser numpydoc sphinx sphinx_rtd_theme
- name: Build API documentation
run: |
sphinx-apidoc -Mfeo sphinx_documentation/docs/source sphinx_documentation/mycosmo
sphinx-build sphinx_documentation/docs/source sphinx_documentation/docs/build
- name: Deploy API documentation
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: sphinx_documentation/docs/build
publish_branch: gh-pages