GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — [3.10] gh-95789: update documentation RFC base URL by JulianMaurin · Pull Request #95800 · python/cpython

Conversation

@JulianMaurin

@JulianMaurin JulianMaurin commented Aug 8, 2022 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

I did not find any way to override docutils default settings through sphinx so I had to create this configuration file.

Tested locally ✔️

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?

  • Issue: RFC links are broken #95789

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

emickiewicz reacted with rocket emoji
All reactions
  • 🚀 1 reaction
@bedevere-bot

bedevere-bot commented Aug 8, 2022

Copy link
Copy Markdown

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-bot bedevere-bot added the awaiting review label Aug 8, 2022
@ghost

ghost commented Aug 8, 2022 •
edited by ghost
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.
CLA signed

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@JulianMaurin
pythongh-95789: update documentation RFC base URL
947dd76
@JulianMaurin
JulianMaurin force-pushed the pythongh-95789-doc-rfc-base-url branch from 8173254 to 947dd76 Compare August 8, 2022 19:01
@bedevere-bot

bedevere-bot commented Aug 8, 2022

Copy link
Copy Markdown

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk

hugovk commented Aug 8, 2022

Copy link
Copy Markdown
Member

Rather than putting this in a new Doc/docutils.conf file, can we put rfc_base_url = 'https://datatracker.ietf.org/doc/html/' in the existing conf.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 the security-only branches. Let's ask 3.8/3.9 release manager @ambv.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@JulianMaurin

JulianMaurin commented Aug 9, 2022

Copy link
Copy Markdown
Author

Rather than putting this in a new Doc/docutils.conf file, can we put rfc_base_url = 'https://datatracker.ietf.org/doc/html/' in the existing conf.py?

That was my first intention. But actually conf.py is the configuration of sphinx.
In our case, the rfc_base_url is a docutils configuration (which is a dependency of sphinx).

I had a look at sphinx source code and the sphinx configuration is handled independently from the one of docutils.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk

hugovk commented Aug 9, 2022

Copy link
Copy Markdown
Member

There's a rfc_base_url in both docutils and Sphinx.

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.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@JulianMaurin

JulianMaurin commented Aug 9, 2022

Copy link
Copy Markdown
Author

@hugovk ,

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

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk

hugovk commented Aug 9, 2022

Copy link
Copy Markdown
Member

Ah yes, thanks!

Please could you prefix the title of this PR with "[3.10] " and add a news entry?

JulianMaurin reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@JulianMaurin JulianMaurin changed the title pythongh-95789: update documentation RFC base URL [3.10] pythongh-95789: update documentation RFC base URL Aug 9, 2022
@blurb-it
📜🤖 Added by blurb_it.
bb9f5a0
hugovk
hugovk approved these changes Aug 9, 2022
View reviewed changes

@hugovk hugovk left a comment

Copy link
Copy Markdown
Member

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!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

JulianMaurin reacted with heart emoji
All reactions
  • ❤️ 1 reaction
@bedevere-bot bedevere-bot added awaiting core review and removed awaiting review labels Aug 9, 2022
@ambv ambv changed the title [3.10] pythongh-95789: update documentation RFC base URL [3.10] gh-95789: update documentation RFC base URL Aug 12, 2022
@ambv
ambv merged commit 345daea into python:3.10 Aug 12, 2022
@bedevere-bot bedevere-bot removed the awaiting core review label Aug 12, 2022
CAM-Gerlach added a commit to CAM-Gerlach/cpython that referenced this pull request Oct 16, 2022
@CAM-Gerlach @gpshead
Add int/str security change from issue pythongh-95778 PRs pythongh-96499
12c5273
 / pythongh-95800

Co-authored-by: Gregory P. Smith <[email protected]>
gpshead pushed a commit that referenced this pull request Oct 17, 2022
@CAM-Gerlach
gh-95913: Forward-port int/str security change to 3.11 What's New in …
bb38b39
…main (#98344)

Add int/str security change from issue gh-95778 PRs gh-96499 / gh-95800

Co-authored-by: Gregory P. Smith <[email protected]> [Google]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovk hugovk hugovk approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

4 participants

@JulianMaurin @bedevere-bot @hugovk @ambv
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.