Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/workflows/build_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@ jobs:
pip install --upgrade pip
# force using latest nibabel
pip install -U nibabel
pip install -q ipython Sphinx sphinx-gallery numpydoc # TODO: move to pyproject.toml
pip install -e . --group dev
pip install -e . --group dev --group docs
python -c 'import cortex; print(cortex.__full_version__)'

- name: Cache Playwright browsers
Expand Down
4 changes: 2 additions & 2 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ uv run pytest -p no:cacheprovider --no-cov -x cortex/tests/test_formats.py # qu
### Docs

```bash
uv pip install sphinx_gallery numpydoc # not (yet) a dependency group
cd docs && uv run make html # gallery examples need Inkscape and Playwright too
uv sync --all-extras --group docs # sphinx, sphinx-gallery, numpydoc, ipython, playwright
cd docs && uv run make html # gallery examples also need Inkscape and Playwright Chromium
```

## Architecture
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ You can find many examples of pycortex features in the [pycortex example gallery

To build the documentation locally:
```bash
# Install required dependencies for the documentation
pip install sphinx_gallery numpydoc
# Install pycortex with the documentation dependencies (needs pip >= 25.1)
pip install -e . --group docs
# Move into the docs folder (assuming already in pycortex directory)
cd docs
# Build a local version of the documentation site
Expand Down
9 changes: 9 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,15 @@ types = [
"scipy-stubs",
]

docs = [
# The gallery examples render WebGL views headlessly and use IPython.
"pycortex[headless]",
"ipython",
"numpydoc",
"sphinx",
"sphinx-gallery",
]

[project.optional-dependencies]
headless = [
"playwright>=1.58.0"
Expand Down
Loading