Skip to content

Commit

Permalink
Docs (#225)
Browse files Browse the repository at this point in the history
Fixing workflow hopefully
  • Loading branch information
han16nah authored and Milli97 committed Feb 20, 2025
1 parent 36341f9 commit 72f8574
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 17 deletions.
24 changes: 8 additions & 16 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -1,35 +1,27 @@
name: Docs
on: [push, pull_request, workflow_dispatch]
permissions:
contents: write
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-python@v5
with:
python-version: '3.12'

- name: Install poetry
uses: abatilo/actions-poetry@v3

- name: Install dependencies
run: poetry install --no-root
- name: Setup a local virtual environment for caching
run: |
poetry config virtualenvs.create true --local
poetry config virtualenvs.in-project true --local
- name: Define a cache for the virtual environment based on the dependencies lock file to speed up later runs
uses: actions/cache@v4
with:
path: ./.venv
key: venv-${{ hashFiles('poetry.lock') }}
- name: Install sphinx
run: pip install sphinx sphinx_rtd_theme
- name: Install myst-parser
run: pip install myst-parser
run: poetry install

- name: Sphinx build
run: |
sphinx-build docs _build
poetry run sphinx-build docs _build
- name: Deploy
uses: peaceiris/actions-gh-pages@v4
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
html_extra_path = ["_build"]
html_extra_path = ["_build", "generated"]
html_css_files = [
"css-style.css",
]
Expand Down

0 comments on commit 72f8574

Please sign in to comment.