Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

[3.10] gh-95789: update documentation RFC base URL#95800

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged

Conversation

@JulianMaurin
Copy link

@JulianMaurinJulianMaurin commentedAug 8, 2022
edited
Loading

I did not find any way to overridedocutils default settings throughsphinx so I had to create this configuration file.

Tested locally ✔️

The issue is also impacting python3.7,3.8 and3.9. So I guess I've to create the exact same PR targeting another branch, may you confirm, please?

emickiewicz reacted with rocket emoji
@bedevere-bot
Copy link

Most changes to Pythonrequire a NEWS entry.

Please add it using theblurb_it web app or theblurb command-line tool.

@ghost
Copy link

ghost commentedAug 8, 2022
edited by ghost
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

@JulianMaurinJulianMaurinforce-pushed thepythongh-95789-doc-rfc-base-url branch from8173254 to947dd76CompareAugust 8, 2022 19:01
@bedevere-bot
Copy link

Most changes to Pythonrequire a NEWS entry.

Please add it using theblurb_it web app or theblurb command-line tool.

@hugovk
Copy link
Member

Rather than putting this in a newDoc/docutils.conf file, can we putrfc_base_url = 'https://datatracker.ietf.org/doc/html/' in the existingconf.py?


The issue is also impacting python 3.7, 3.8 and 3.9. So I guess I've to create the exact same PR targeting another branch, may you confirm, please?

As you noted at#95789 (comment), the redirects are fixed now on the IETF side, so it's less pressing to get this backported to thesecurity-only branches. Let's ask 3.8/3.9 release manager@ambv.

@JulianMaurin
Copy link
Author

Rather than putting this in a newDoc/docutils.conf file, can we putrfc_base_url = 'https://datatracker.ietf.org/doc/html/' in the existingconf.py?

That was my first intention. But actuallyconf.py is the configuration ofsphinx.
In our case, therfc_base_url is adocutils configuration (which is a dependency ofsphinx).

I had a look atsphinx source code andthe sphinx configuration is handled independently fromthe one of docutils.

@hugovk
Copy link
Member

There's arfc_base_url in bothdocutils andSphinx.

We're overriding this setting in Sphinx:

'rfc_base_url':'https://datatracker.ietf.org/doc/html/',

https://github.com/sphinx-doc/sphinx/blob/f45dc5e1398f7850e23003cac200ad3433da2a78/sphinx/environment/__init__.py#L47

To test, I modified that line directly in Sphinx and rebuilt the docs, and it used that modified one.

@JulianMaurin
Copy link
Author

@hugovk ,

Yes, it's exactly the link I refer in my last message.
I invite you to test, puttingrfc_base_url in theconf.py. Rebuilding the documentation you will see that there is no impact.

(cf.https://www.sphinx-doc.org/en/master/usage/configuration.html)

@hugovk
Copy link
Member

Ah yes, thanks!

Please could youprefix the title of this PR with "[3.10] " and add anews entry?

JulianMaurin reacted with thumbs up emoji

@JulianMaurinJulianMaurin changed the titlepythongh-95789: update documentation RFC base URL[3.10] pythongh-95789: update documentation RFC base URLAug 9, 2022
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!

JulianMaurin reacted with heart emoji
@ambvambv changed the title[3.10] pythongh-95789: update documentation RFC base URL[3.10] gh-95789: update documentation RFC base URLAug 12, 2022
@ambvambv merged commit345daea intopython:3.10Aug 12, 2022
CAM-Gerlach added a commit to CAM-Gerlach/cpython that referenced this pull requestOct 16, 2022
gpshead pushed a commit that referenced this pull requestOct 17, 2022
…main (#98344)Add int/str security change from issuegh-95778 PRsgh-96499 /gh-95800Co-authored-by: Gregory P. Smith <greg@krypto.org> [Google]
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@hugovkhugovkhugovk approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@JulianMaurin@bedevere-bot@hugovk@ambv

[8]ページ先頭

©2009-2025 Movatter.jp