-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
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
MAINT: Update the documentation Makefile #21849
Conversation
89fe7d5
to
a764ac4
Compare
Should https://numpy.org/doc/stable/dev/releasing.html be updated accordingly? |
Yep, also the walkthrough, which needs other changes as well. The big change is the missing pdf files, |
I think PDF needs changing to HTML+zip for 1.24:
I'm not sure where it resides, or what the best way forward is there. EDIT: It's in |
c257bcb
to
4c451f5
Compare
This does several things - Uses a virtual environment for the documentent build. This allows installing the proper NumPy version with pip and works with all recent Python versions. - Installs the dependencies current in the {doc|test}requirements files. That makes it easier to insure that the proper versions are used. - Removes the latex/pdf builds. Those builds are currently buggy and hard to maintain and we have chosen to remove the pdf documents until that is fixed. Removing them cleans up the file to some extent. This all makes it easier to document how to build the docs. I was editing the Makefile on the fly before this, and that sort of knowledge is tricky to pass on to new maintainers.
0808c0b
to
a595819
Compare
We don't seem to have a good explanation of local wheel builds. Maybe just |
- Document the changes in the documentation generation. - Rearrange the wheel generation sections
Update HOWTO_RELEASE.rst and remove sections that are duplicated in the RELEASE_WALKTHROUGH.rst file.
a595819
to
c083c51
Compare
Self merging. @melissawm There are three files that should probably be edited so that they fit together in the documentation.
I cut out a fair amount of the |
Thanks, @charris ! |
This does several things
installing the proper NumPy version with pip and works with all
recent Python versions.
That makes it easier to insure that the proper versions are used.
hard to maintain and we have chosen to remove the pdf documents until
that is fixed. Removing them cleans up the file to some extent.
This all makes it easier to document how to build the docs. I was
editing the Makefile on the fly before this, and that sort of knowledge
is tricky to pass on to new maintainers.
EDIT: There are a number of other targets for making helpfiles, coverage, etc. Some modification is needed to run them in the virtual environment. What should we do with those? Are they used downstream? One workaround would be to first run
make docenv; source docenv/bin/activate
and proceed as before. This could also be used for the two commands (make dist
andmake merge-doc
) that we currently use. I'm thinking this should this be the standard method and the easiest for possible downstream users.