Skip to content

Docs: remove unused Makefile targets #8917

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

Merged
merged 3 commits into from
Apr 21, 2025

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Apr 19, 2025

I plan to do some more refactoring of docs/Makefile, but first, there's a number of targets that we're not using, and some of which aren't even working. Let's remove them.

We're only really using html, but I left some other html variants in there like dirhtml and singlehtml. linkcheck can also be useful from time to time.

Also removed from docs/make.bat but I don't have Windows to test with, and probably won't many future changes to this file.

If someone now or subsequently says they use any of these, we can add them back.

The non-working targets:

  • json
  • pickle
  • latexpdf (if no latexmk installed)
  • info
  • doctest

@radarhere
Copy link
Member

Here's my investigation of the non-working targets,

  • ‘json’ and ‘pickle’ raise an error
sphinx.errors.ExtensionError: Handler <function html_page_context at 0x107d27920> for event 'html-page-context' threw an exception (exception: 'pagename')
  • ‘latexpdf’ does indeed raise
latexmk: No such file or directory
  • ‘info’ doesn’t raise an error. It does produce a number of warnings
WARNING: a suitable image for texinfo builder not found
warning: @footnote should not appear on @deffn line
warning: @subsubsection missing argument
  • ‘doctest’ raises an error
sphinx.errors.SphinxError: Builder name doctest not registered or available through entry point

@radarhere radarhere merged commit d03ce3d into python-pillow:main Apr 21, 2025
5 checks passed
@hugovk hugovk deleted the docs-makefile-rm-unused-targets branch April 21, 2025 09:12
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.

2 participants