-
-
Notifications
You must be signed in to change notification settings - Fork 30.9k
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
gh-119009: Add gettext target #119006
gh-119009: Add gettext target #119006
Conversation
rffontenelle
commented
May 13, 2024
•
edited by hugovk
Loading
edited by hugovk
- Issue: Add gettext target to documentation's Makefile #119009
d05ab47
to
5254761
Compare
Could you copy details on the problem and proposed solution in a github issue? For CPython we like to have the problem discussed in an issue, and discusson on the PR can be focussed on the implementation itself. For this ticket there probably won’t be any debate on the issue, but I wanted to clarify this part of the workflow for future contributions! |
Sure, issue opened. |
Please could you add a help entry (see line 30) so it shows up in: ❯ make -C Doc help
Please use `make <target>' where <target> is one of
clean to remove build files
venv to create a venv with necessary tools
html to make standalone HTML files
htmlview to open the index page built by the html target in your browser
htmllive to rebuild and reload HTML files in your browser
htmlhelp to make HTML files and a HTML help project
latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
text to make plain text files
texinfo to make Texinfo file
epub to make EPUB files
changes to make an overview over all changed/added/deprecated items
linkcheck to check all external links for integrity
coverage to check documentation coverage for library and C API
doctest to run doctests in the documentation
pydoc-topics to regenerate the pydoc topics file
dist to create a "dist" directory with archived docs for download
check to run a check for frequent markup errors |
I get an error running this, what am I missing? ❯ make -C Doc gettext
mkdir -p build
Building NEWS from Misc/NEWS.d with blurb
/Users/hugo/github/python/cpython/main/Doc/build/NEWS is already up to date
PATH=./venv/bin:$PATH sphinx-build -b gettext -d build/doctrees -j auto -W . build/gettext
Running Sphinx v7.3.7
loading pickled environment... done
Sphinx error:
This environment is incompatible with the selected builder, please choose another doctree directory.
make: *** [build] Error 2 That's from the repo root. I get the same thing with |
Oh, I've seen it before. I believe to be something related to the doctree being in the same directory, but I didn't dig for the reason. |
I pushed a workaround: set another doctree directory for gettext. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
Thanks @rffontenelle for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
(cherry picked from commit fb0cf7d) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
(cherry picked from commit fb0cf7d) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
GH-119074 is a backport of this pull request to the 3.13 branch. |
GH-119075 is a backport of this pull request to the 3.12 branch. |