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.

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

docs: Use intersphinx_registry to keep intersphinx urls up to date #2559

Merged
merged 3 commits into from
Dec 3, 2024

Conversation

Carreau
Copy link
Contributor

@Carreau Carreau commented Nov 18, 2024

I think one of the difference is it will point toward uproot stable instead of latest (which is the dev version).

Checklist Before Requesting Reviewer

  • Tests are passing
    • No, but expected.
  • "WIP" removed from the title of the pull request
  • Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

  • Summarize commit messages into a comprehensive review of the PR
* Add intersphinx_registry to 'docs' extra.
* Use intersphinx_registry to provide automated inter Sphinx mapping.
   - c.f. https://github.com/Quansight-labs/intersphinx_registry
* Add Matthias Bussonnier to contributors list.

@Carreau
Copy link
Contributor Author

Carreau commented Nov 18, 2024

I think that will be of interest for @matthewfeickert from our discussion in Quansight-Labs/intersphinx_registry#42

@Carreau Carreau changed the title Use intersphinx_registry to keep intersphinx urls up to date. Docs: Use intersphinx_registry to keep intersphinx urls up to date Nov 18, 2024
@Carreau Carreau changed the title Docs: Use intersphinx_registry to keep intersphinx urls up to date docs: Use intersphinx_registry to keep intersphinx urls up to date Nov 18, 2024
@Carreau Carreau force-pushed the intersphinx_registry branch from 9cef667 to 2b77cb0 Compare November 18, 2024 08:05
Copy link
Member

@matthewfeickert matthewfeickert left a comment

Choose a reason for hiding this comment

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

Many thanks, @Carreau! I'll need to review this more in the morning (my time) but I think we'll also need to add intersphinx-registry as a dependency to the docs extra

pyhf/pyproject.toml

Lines 116 to 130 in 1f1adc7

docs = [
"pyhf[xmlio,contrib]",
"sphinx>=7.0.0", # c.f. https://github.com/scikit-hep/pyhf/pull/2271
"sphinxcontrib-bibtex>=2.1",
"sphinx-click",
"pydata-sphinx-theme>=0.15.3",
"nbsphinx!=0.8.8", # c.f. https://github.com/spatialaudio/nbsphinx/issues/620
"ipywidgets",
"sphinx-issues",
"sphinx-copybutton>=0.3.2,!=0.5.1",
"jupyterlite-sphinx>=0.13.1", # c.f. https://github.com/scikit-hep/pyhf/pull/2458
"jupyterlite-pyodide-kernel>=0.0.7",
"jupytext>=1.14.0",
"ipython!=8.7.0", # c.f. https://github.com/scikit-hep/pyhf/pull/2068
]

(Also, the non-docs CI will fail, but that's because I've been too swamped to fix things that I know are erroring given PyTorch.)

@Carreau
Copy link
Contributor Author

Carreau commented Nov 18, 2024

No hurry I'm in a train just catching up on stuff; and it's not urgent; has few risks to conflict and easy to redo if needs be.

I think we'll also need to add intersphinx-registry as a dependency to the docs extra

That should already be there:

--- a/pyproject.toml
+++ b/pyproject.toml
@@ -121,6 +121,7 @@ docs = [
     "pydata-sphinx-theme>=0.15.3",
     "nbsphinx!=0.8.8",  # c.f. https://github.com/spatialaudio/nbsphinx/issues/620
     "ipywidgets",
+    "intersphinx_registry",
     "sphinx-issues",
     "sphinx-copybutton>=0.3.2,!=0.5.1",
     "jupyterlite-sphinx>=0.13.1",  # c.f. https://github.com/scikit-hep/pyhf/pull/2458

Also : who does not sort their extras !

Carreau and others added 3 commits December 3, 2024 12:48
I think one of the difference is it will point toward uproot stable
instead of latest (which is the dev version).
@matthewfeickert
Copy link
Member

(Bumping again as GitHub seems to be confused about the diff and is showing things already on main). This is good to go now, but GitHub was 500ing earlier and so I'm just checking how things are doing now.

@matthewfeickert matthewfeickert added docs Documentation related need-to-backport tmp label until can be backported to patch release branch labels Dec 3, 2024
Copy link
Member

@matthewfeickert matthewfeickert left a comment

Choose a reason for hiding this comment

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

Thanks so much @Carreau! (Also apologies for the 2 week delay and broken tests — end of the year proposals have not been kind to my open source time)

@matthewfeickert matthewfeickert merged commit 001d477 into scikit-hep:main Dec 3, 2024
4 of 5 checks passed
@Carreau
Copy link
Contributor Author

Carreau commented Dec 4, 2024

No worries, I also have long standing PRs I need to review !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related need-to-backport tmp label until can be backported to patch release branch
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants