Skip to content

Commit

Permalink
dev: Fix docs dependencies and website generation via pdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
adigitoleo committed Apr 6, 2024
1 parent 4dffdf2 commit 9476334
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: '3.12'
python-version: '3.11'

- name: Build
run: |
Expand All @@ -32,8 +32,8 @@ jobs:
python3 -m pip install --upgrade pip
python3 -m venv .venv-gh-pages
source .venv-gh-pages/bin/activate
python3 -m pip install "$PWD"[doc,test]
pdoc -t docs/template -o html --math pydrex !pydrex.mesh !pydrex.distributed tests
python3 -m pip install "$PWD"[doc]
pdoc -t docs/template -o html --math pydrex tests
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
# If you're changing the branch from main,
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ dependencies = [

[project.optional-dependencies]
test = ["pytest"]
doc = ["pdoc"]
mesh = ["gmsh"] # NOTE: Saying `import gmsh` is like saying "I don't want my CI to work".
doc = ["pdoc", "pytest", "gmsh", "ray"]
mesh = ["gmsh"]
ray = ["ray >= 2.0.0"]
dev = ["pytest", "uniplot", "pdoc", "ruff", "black", "isort", "ptpython"]
lsp = ["python-lsp-server", "pyls-isort", "python-lsp-black", "python-lsp-ruff"]
Expand Down

0 comments on commit 9476334

Please sign in to comment.