Skip to content

Commit

Permalink
Modifying github actions for documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
TJ202 committed Nov 5, 2024
1 parent cb77aae commit 849e0ac
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,25 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5

- name: Install dependencies
run: |
pip install "sphinx==8.1.3" "sphinx-copybutton==0.5.2" "sphinx-hoverxref==1.4.1" "sphinx-click==6.0.0" sphinx_rtd_theme myst_parser autodoc-pydantic "sphinx-autobuild==2024.10.3"
pip install --upgrade pip
pip install "sphinx==8.1.3" "sphinx-copybutton==0.5.2" "sphinx-hoverxref==1.4.1" \
"sphinx-click==6.0.0" "sphinx_rtd_theme" "myst_parser" \
"autodoc-pydantic==2.2.0" "sphinx-autobuild==2024.10.3"
- name: Verify installation
run: pip show autodoc-pydantic

- name: Sphinx build
run: |
sphinx-build docs/source _build
run: sphinx-build docs/source _build

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: github_pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true
force_orphan: true

0 comments on commit 849e0ac

Please sign in to comment.