Skip to content

Use importlib.metadata in docs build #3194

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

Merged
CoolCat467 merged 2 commits into from
Jan 30, 2025
Merged

Use importlib.metadata in docs build #3194

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
1e7c145
Install trio in RTD and use importlib.metadata.version
A5rocks Jan 29, 2025
ad2d101
Try to remove a sys.path update
A5rocks Jan 29, 2025
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
1 change: 1 addition & 0 deletions .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ build:
python:
install:
- requirements: docs-requirements.txt
- path: .

sphinx:
fail_on_warning: true
Expand Down
6 changes: 2 additions & 4 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@

# For our local_customization module
sys.path.insert(0, os.path.abspath("."))
# For trio itself
sys.path.insert(0, os.path.abspath("../../src"))

# Enable reloading with `typing.TYPE_CHECKING` being True
os.environ["SPHINX_AUTODOC_RELOAD_MODULES"] = "1"
Expand Down Expand Up @@ -315,9 +313,9 @@ def add_mapping(
# built documents.
#
# The short X.Y version.
import trio
import importlib.metadata

version = trio.__version__
version = importlib.metadata.version("trio")
# The full version, including alpha/beta/rc tags.
release = version

Expand Down