Skip to content

Conversation

@rffontenelle
Copy link
Contributor

@rffontenellerffontenelle commented May 13, 2024

@ghost
Copy link

ghost commented May 13, 2024

All commit authors signed the Contributor License Agreement.
CLA signed

@merwok
Copy link
Member

Could you copy details on the problem and proposed solution in a github issue?
That way, we have info in the issues, solution in the PR, and nothing locked in discuss.

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!

@rffontenellerffontenelle changed the title docs: Add gettext targetgh-119009: Add gettext targetMay 13, 2024
@rffontenelle
Copy link
ContributorAuthor

Could you copy details on the problem and proposed solution in a github issue?

Sure, issue opened.

@hugovk
Copy link
Member

Please could you add a help entry (see line 30) so it shows up in:

make -C Doc helpPlease 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

@hugovk
Copy link
Member

I get an error running this, what am I missing?

make -C Doc gettextmkdir -p buildBuilding NEWS from Misc/NEWS.d with blurb/Users/hugo/github/python/cpython/main/Doc/build/NEWS is already up to datePATH=./venv/bin:$PATH sphinx-build -b gettext -d build/doctrees -j auto -W . build/gettextRunning Sphinx v7.3.7loading pickled environment... doneSphinx 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 cd Doc; make gettext.

@hugovkhugovk added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels May 14, 2024
@rffontenelle
Copy link
ContributorAuthor

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.

@rffontenelle
Copy link
ContributorAuthor

I pushed a workaround: set another doctree directory for gettext.

Copy link
Member

@hugovkhugovk left a comment

Choose a reason for hiding this comment

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

Thank you!

@hugovkhugovk merged commit fb0cf7d into python:mainMay 15, 2024
@miss-islington-app
Copy link

Thanks @rffontenelle for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 15, 2024
(cherry picked from commit fb0cf7d) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 15, 2024
(cherry picked from commit fb0cf7d) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
@bedevere-app
Copy link

GH-119074 is a backport of this pull request to the 3.13 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.13 bugs and security fixes label May 15, 2024
@bedevere-app
Copy link

GH-119075 is a backport of this pull request to the 3.12 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.12 only security fixes label May 15, 2024
hugovk pushed a commit that referenced this pull request May 15, 2024
Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
hugovk pushed a commit that referenced this pull request May 15, 2024
Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
@rffontenellerffontenelle deleted the add-gettext-target branch May 15, 2024 18:40
@JelleZijlstraJelleZijlstra mentioned this pull request May 28, 2024
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@rffontenelle@merwok@hugovk@Seluj78@egeakman