Skip to content

Conversation

rossbar
Copy link
Contributor

@rossbar rossbar commented Mar 15, 2022

This PR updates how the scipy documentation uses numpydoc; removing numpydoc as a git submodule and instead relying on the released version as a dependency. numpydoc is already listed as a dependency in most relevant places (pyproject.toml, various environments files). This PR completes the process by removing the git submodule and various other manual shims and references.

Reference issue

There is no reference issue, but this was discussed in the scipy community meeting.

What does this implement/fix?

Updates/simplifies how the numpydoc doc dependency is managed.

Additional information

Note that explicit testing against scipy is part of the release process for numpydoc.

Copy link
Member

@tupui tupui left a comment

Choose a reason for hiding this comment

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

Thanks @rossbar

@@ -3,4 +3,5 @@
Sphinx!=3.1.0, !=4.1.0
pydata-sphinx-theme>=0.6.1
sphinx-panels>=0.5.2
numpydoc==1.1
Copy link
Member

Choose a reason for hiding this comment

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

Any reason for the pinned version?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Any reason for the pinned version?

Namely consistency with the pins in pyproject.toml and environment.yml. This can and should be bumped to 1.2, but that requires the change in e3c152f from #15443 first. If this PR goes in before #15443, I'd be happy to rebase and bump the numpydoc version there.

Copy link
Member

Choose a reason for hiding this comment

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

Ok sure if there are blockers. Otherwise as you can see from the other doc dependencies there is no pin. Just versions to skip.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Otherwise as you can see from the other doc dependencies there is no pin.

👍 my vote would be to put this PR in before #15443, then remove the numpydoc pins in #15443.

@tupui tupui added Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org maintenance Items related to regular maintenance tasks labels Mar 15, 2022
@rgommers rgommers added this to the 1.9.0 milestone Mar 16, 2022
@tupui
Copy link
Member

tupui commented Mar 21, 2022

After discussing this on our last meeting, I propose to merge this at the end of the week (2022-3-25) if there are no further comments.

@tupui
Copy link
Member

tupui commented Mar 25, 2022

No complains, it's Friday, merging. Thanks again @rossbar

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org maintenance Items related to regular maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants