Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: speed up RtD #576

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs: speed up RtD #576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f07349
docs: speed up RtD
henryiii Jul 3, 2024
1b59bf1
docs: do not require setuptools for docs
henryiii Jul 3, 2024
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
24 changes: 8 additions & 16 deletions .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,13 @@ version: 2
build:
os: "ubuntu-22.04"
tools:
python: "3.10"
python: "3.12"
apt_packages:
- graphviz


# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# Include PDF and ePub
formats: all

python:
install:
- method: pip
path: .
extra_requirements:
- docs
commands:
- asdf plugin add uv
- asdf install uv latest
- asdf global uv latest
- uv venv
- uv pip install .[docs]
- .venv/bin/python -m sphinx -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html
6 changes: 2 additions & 4 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,14 @@

from __future__ import annotations

# Warning: do not change the path here. To use autodoc, you need to install the
# package first.
from pkg_resources import get_distribution
import importlib.metadata

# -- Project information -----------------------------------------------------

project = "Hist"
copyright = "2020, Henry Schreiner"
author = "Henry Schreiner and Nino Lau"
version = get_distribution("hist").version
version = importlib.metadata.version("hist")


# -- General configuration ---------------------------------------------------
Expand Down
Loading