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
12 changes: 7 additions & 5 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
os: ubuntu-24.04
tools:
python: "3.11"
jobs:
Expand All @@ -26,9 +26,11 @@ formats:
# - pdf
# - epub

# Optionally declare the Python requirements required to build your docs
# Install PyroLab and the "docs" dependency group from uv.lock (uv sync), the
# same environment `make doc` builds with locally.
python:
install:
- requirements: docs/requirements.txt
- method: pip
path: .
- method: uv
command: sync
groups:
- docs
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,12 +221,9 @@ as CI does.
Much of the API documentation is autogenerated from the source code. Gitignores
are in place to prevent you from committing autogenerated pages.

To build the docs, navigate to the ``docs/`` directory and run:

```
pip install -r requirements.txt
make html
```
To build the docs, run ``make doc`` (which installs the ``docs`` dependency
group), then ``make serve`` to view them at http://localhost:8000. Read the Docs
builds them the same way, from ``uv.lock``.

## Building the Package

Expand Down
6 changes: 0 additions & 6 deletions docs/requirements.txt

This file was deleted.

Loading