Skip to content
Merged
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
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ build:
commands:
# Install uv and sync dependencies from uv.lock
- pip install uv
- uv sync --frozen
- uv sync --frozen --no-dev --group docs
- uv run sphinx-build -b html docs $READTHEDOCS_OUTPUT/html

# Build documentation from the docs/ directory using Sphinx
Expand Down
8 changes: 8 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,3 +82,11 @@ I use `uv <https://docs.astral.sh/uv/>`_, and if you do too: you just clone this
to your computer, then run ``uv sync`` in the root directory. Example usage::

uv run pytest

For docs, install only the docs dependencies with::

uv sync --no-dev --group docs

Or to install everything (all dependency groups), run::

uv sync --all-groups
5 changes: 2 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,8 @@ dev = [
"mypy>=1.4.1",
"numpy>=1.21.6",
"pytest>=7.4.4",
"sphinx>=4.3.2",
"sphinx-autobuild>=2021.3.14",
]
docs = [
"sphinx-autobuild>=2021.3.14",
"sphinx>=7.4.7; python_version >= '3.12'",
"sphinx-autobuild>=2021.3.14; python_version >= '3.12'",
]
Loading
Loading