Skip to content

Commit

Permalink
[feat]: added docs deploy
Browse files Browse the repository at this point in the history
  • Loading branch information
Vl-Tershch committed Jun 2, 2024
1 parent 029b387 commit 772b485
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,24 @@ jobs:
- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme myst_parser
- name: Sphinx build
run: |
sphinx-build docs _build
python -m pip install -U sphinx
python -m pip install sphinx-rtd-theme
python -m pip install sphinx-autoapi
- name: make the sphinx docs
run: |
make -C docs clean
# sphinx-apidoc -f -o docs/source . -H Test -e -t docs/source/_templates
make -C docs html
- name: Deploy to GitHub Pages
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: _build/
directory: ./docs/build/html
force_orphan: true

0 comments on commit 772b485

Please sign in to comment.