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

Update the intersphinx urls as the warnings suggested #38873

Merged

Conversation

peterfpeterson
Copy link
Member

@peterfpeterson peterfpeterson commented Feb 17, 2025

Building the docs-html target was warning about needing to update intersphinx links. This does what the warnings said to do.

There is no associated issue.

To test:

ninja docs-html

before and after this. One will show intersphinx URL warnings. Hopefully, it is the first one.

This does not require release notes because it is fixing a build server warning.


Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review

  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Do the release notes conform to the release notes guide?

Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.

@peterfpeterson peterfpeterson added the Maintenance Unassigned issues to be addressed in the next maintenance period. label Feb 17, 2025
@peterfpeterson peterfpeterson added this to the Release 6.13 milestone Feb 17, 2025
@peterfpeterson peterfpeterson added the Documentation Issues and pull requests related to documentation label Feb 18, 2025
@peterfpeterson peterfpeterson marked this pull request as ready for review February 18, 2025 18:44
@backmari
Copy link
Contributor

I ran ninja docs-html before and after these changes.

Before:

Converting `source_suffix = '.rst'` to `source_suffix = {'.rst': 'restructuredtext'}`.
loading intersphinx inventory 'h5py' from https://h5py.readthedocs.io/en/stable/objects.inv...
loading intersphinx inventory 'matplotlib' from https://matplotlib.org/objects.inv...
loading intersphinx inventory 'numpy' from https://numpy.org/doc/stable/objects.inv...
loading intersphinx inventory 'python' from https://docs.python.org/3/objects.inv...
loading intersphinx inventory 'SciPy' from https://docs.scipy.org/doc/scipy/reference/objects.inv...
loading intersphinx inventory 'pandas' from https://pandas.pydata.org/pandas-docs/stable/objects.inv...
loading intersphinx inventory 'pystog' from https://pystog.readthedocs.io/en/latest/objects.inv...
loading intersphinx inventory 'mantid-dev' from https://developer.mantidproject.org/objects.inv...
intersphinx inventory has moved: https://matplotlib.org/objects.inv -> https://matplotlib.org/stable/objects.inv
intersphinx inventory has moved: https://docs.scipy.org/doc/scipy/reference/objects.inv -> https://docs.scipy.org/doc/scipy/objects.inv
intersphinx inventory has moved: https://h5py.readthedocs.io/en/stable/objects.inv -> https://docs.h5py.org/en/stable/objects.inv
building [mo]: targets for 0 po files that are out of date

After (the three "has moved" messages are gone):

Converting `source_suffix = '.rst'` to `source_suffix = {'.rst': 'restructuredtext'}`.
loading intersphinx inventory 'h5py' from https://docs.h5py.org/en/stable/objects.inv...
loading intersphinx inventory 'matplotlib' from https://matplotlib.org/stable/objects.inv...
loading intersphinx inventory 'numpy' from https://numpy.org/doc/stable/objects.inv...
loading intersphinx inventory 'python' from https://docs.python.org/3/objects.inv...
loading intersphinx inventory 'SciPy' from https://docs.scipy.org/doc/scipy/objects.inv...
loading intersphinx inventory 'pandas' from https://pandas.pydata.org/pandas-docs/stable/objects.inv...
loading intersphinx inventory 'pystog' from https://pystog.readthedocs.io/en/latest/objects.inv...
loading intersphinx inventory 'mantid-dev' from https://developer.mantidproject.org/objects.inv...
building [mo]: targets for 0 po files that are out of date

Copy link
Contributor

@backmari backmari left a comment

Choose a reason for hiding this comment

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

This change makes the docs build warnings go away as described.

@rosswhitfield rosswhitfield merged commit fee4ecd into mantidproject:main Feb 19, 2025
10 checks passed
@peterfpeterson peterfpeterson deleted the intersphinx_url_update branch February 20, 2025 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues and pull requests related to documentation Maintenance Unassigned issues to be addressed in the next maintenance period.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants