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

gh-119009: Add gettext target #119006

Merged
merged 3 commits into from
May 15, 2024
Merged

Conversation

rffontenelle
Copy link
Contributor

@rffontenelle rffontenelle commented May 13, 2024

Copy link

cpython-cla-bot bot commented May 13, 2024

All commit authors signed the Contributor License Agreement.
CLA signed

@merwok
Copy link
Member

merwok commented May 13, 2024

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!

@rffontenelle rffontenelle changed the title docs: Add gettext target gh-119009: Add gettext target May 13, 2024
@rffontenelle
Copy link
Contributor Author

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

Sure, issue opened.

@hugovk
Copy link
Member

hugovk commented May 14, 2024

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

@hugovk
Copy link
Member

hugovk commented May 14, 2024

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 cd Doc; make gettext.

@hugovk hugovk added needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes labels May 14, 2024
@rffontenelle
Copy link
Contributor Author

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
Contributor Author

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

Copy link
Member

@hugovk hugovk 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!

@hugovk hugovk merged commit fb0cf7d into python:main May 15, 2024
27 checks passed
@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 <[email protected]>
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 <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented May 15, 2024

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

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

bedevere-app bot commented May 15, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label May 15, 2024
hugovk pushed a commit that referenced this pull request May 15, 2024
hugovk pushed a commit that referenced this pull request May 15, 2024
@rffontenelle rffontenelle deleted the add-gettext-target branch May 15, 2024 18:40
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
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.

5 participants