Skip to content

Add a version menu to the Sphinx build #394

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
merged 3 commits into from
May 2, 2022
Merged

Add a version menu to the Sphinx build #394

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
682b832
Fix warnings in the Sphinx build
asmeurer Feb 21, 2022
efb2ea6
Include the version number in the header
asmeurer Feb 21, 2022
018a542
Enable the version dropdown menu
asmeurer Feb 21, 2022
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
8 changes: 5 additions & 3 deletions spec/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@
('py:class', 'collections.abc.Sequence'),
('py:class', "Optional[Union[int, float, Literal[inf, - inf, 'fro', 'nuc']]]"),
('py:class', "Union[int, float, Literal[inf, - inf]]"),
('py:obj', "typing.Optional[typing.Union[int, float, typing.Literal[inf, - inf, 'fro', 'nuc']]]"),
('py:obj', "typing.Union[int, float, typing.Literal[inf, - inf]]"),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like it's going to be a continuous source of friction. Not a blocker for this PR, but can't we just turn off this cross-linking?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you know how to do it let me know. When I looked there didn't seem to be a way.

('py:class', 'PyCapsule'),
('py:class', 'enum.Enum'),
('py:class', 'ellipsis'),
Expand Down Expand Up @@ -123,7 +125,7 @@
html_theme_options = {

# Set the name of the project to appear in the navigation.
'nav_title': 'Python array API standard',
'nav_title': f'Python array API standard {release}',

# Set you GA account ID to enable tracking
#'google_analytics_account': 'UA-XXXXX',
Expand Down Expand Up @@ -170,8 +172,8 @@
#"customization": "Configuration options to personalize your site.",
},

#"version_dropdown": True,
#"version_json": "_static/versions.json",
"version_dropdown": True,
"version_json": "../versions.json",
"table_classes": ["plain"],
}

Expand Down