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

MAINT: Update the documentation Makefile #21849

Merged
merged 3 commits into from
Jun 29, 2022

Conversation

charris
Copy link
Member

@charris charris commented Jun 24, 2022

This does several things

  • Uses a virtual environment for the document 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.

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 and make merge-doc) that we currently use. I'm thinking this should this be the standard method and the easiest for possible downstream users.

@melissawm
Copy link
Member

Should https://numpy.org/doc/stable/dev/releasing.html be updated accordingly?

@charris
Copy link
Member Author

charris commented Jun 24, 2022

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, make dist or merge-doc will otherwise work as before, just a bit better, so no changes are needed respecting those commands. We haven't used paver for building docs since forever, so that bit can also be deleted from the release documentation.

@charris
Copy link
Member Author

charris commented Jun 24, 2022

I think PDF needs changing to HTML+zip for 1.24:

Download documentation: PDF Version | Historical versions of documentation

I'm not sure where it resides, or what the best way forward is there.

EDIT: It's in doc/source/index.rst, but is just a link that opens the PDF. That isn't quite the same as a download.

@charris charris force-pushed the update-doc-makefile branch 3 times, most recently from c257bcb to 4c451f5 Compare June 25, 2022 18:17
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.
@charris charris force-pushed the update-doc-makefile branch 5 times, most recently from 0808c0b to a595819 Compare June 25, 2022 23:41
@charris
Copy link
Member Author

charris commented Jun 26, 2022

We don't seem to have a good explanation of local wheel builds. Maybe just python setup.py bdist_wheel together with OpenBLAS should be sufficient?

- 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.
@charris charris merged commit 2c79206 into numpy:main Jun 29, 2022
@charris charris deleted the update-doc-makefile branch June 29, 2022 17:57
@charris
Copy link
Member Author

charris commented Jun 29, 2022

Self merging. @melissawm There are three files that should probably be edited so that they fit together in the documentation.

  1. HOWTO_RELEASE.rst
  2. BRANCH_WALKTHROUGH.rst
  3. RELEASE_WALKTHROUGH.rst

I cut out a fair amount of the HOWTO_RELEASE.rst file as duplicated in the walkthrough.

@melissawm
Copy link
Member

Thanks, @charris !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants