GeezerVison

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

GeezerVison is showing github.com — bpo-41028: Doc: Move switchers to docsbuild-scripts. by JulienPalard · Pull Request #20969 · python/cpython

Conversation

JulienPalard commented Jun 18, 2020 •

edited

Loading

Uh oh!

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

Copy link

Copy Markdown

Member

TL;DR: I'm moving language and version switchers (manually maintained in every branches), and "indexlayout" (left menu, in docs.python.org, with a list of versions, manually maintained in every branches), to docsbuild-scripts.

The current version of docs.python.org already uses the new language picker, version picker, and indexsidebar, I build all french versions with it manually, other languages will be built in a few hours.

There's no hurry to merge this PR, docsbuild-scripts accomodate to its presence or absence, and it does not need to be backported.

More info: https://mail.python.org/pipermail/doc-sig/2020-June/004200.html

I took some liberties:

I added some translation to dummy.html, even if docsbuild-script don't use them yet, it should in the future.
I added an id to the <li> where the language and version switchers should land, to avoid ugly selectors to try to find it, and eventual bugs associated with ugly selectors. Docsbuild-script don't use it yet but should in the future.

This should avoid commits like: 19e3e00, 85c6f8c, 3f36043, 59e7bbc, which had to be backported as far as possible (I was not a big fan of pushing thoses changes to security-only branches, but it was the only way to have an up-to-date sidebar and switcher on their doc).

https://bugs.python.org/issue41028

Sorry, something went wrong.

Uh oh!

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

ZackerySpytz reacted with thumbs up emoji

All reactions

👍 1 reaction

JulienPalard added the docs Documentation in the Doc dir label

Jun 18, 2020

the-knights-who-say-ni added the CLA signed label

Jun 18, 2020

bedevere-bot added the awaiting core review label

Jun 18, 2020

JulienPalard requested a review from ned-deily

June 18, 2020 21:46

JulienPalard mentioned this pull request

Jun 18, 2020

PEP 101: Simplified due to centralisation of switchers in the doc. python/peps#1438

Merged

JulienPalard commented Jun 19, 2020

Copy link

Copy Markdown

Member Author

This goes as expected in production, all 3.7 translations are built, and all french translations are built, I see no issues at the moment, starting to build docs for 3.8.

All reactions

Sorry, something went wrong.

Uh oh!

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

JulienPalard commented Jun 19, 2020

Copy link

Copy Markdown

Member Author

In production, this is now starting to fix links and picker for the 2.7 version, which was stating:

Docs by version

    Python 3.9 (in development)

and now displays:

Docs by version

    Python 3.10 (in development)

All reactions

Sorry, something went wrong.

Uh oh!

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

JulienPalard mentioned this pull request

Jun 20, 2020

Make the theme responsive python/python-docs-theme#46

Merged

JulienPalard commented Jun 21, 2020

Copy link

Copy Markdown

Member Author

Don't merge until we have a concensus on python/python-docs-theme#46.

All reactions

Sorry, something went wrong.

Uh oh!

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

JulienPalard added the DO-NOT-MERGE label

Jun 21, 2020

ned-deily approved these changes

Jun 22, 2020

View reviewed changes

ned-deily 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.

LGTM. I think the "stand-alone" sidebar looks fine with the Stable, Development, and All Versions links. This is a really nice maintainability improvement.

Sorry, something went wrong.

Uh oh!

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

All reactions

bedevere-bot added awaiting merge and removed awaiting core review labels

Jun 22, 2020

JulienPalard added 2 commits

November 7, 2020 11:48


          Doc: Move switchers to docsbuild-scripts.

b05cd7c


          blurb

33658d1

JulienPalard force-pushed the move-switchers branch from cd6a210 to 33658d1 Compare

November 7, 2020 10:50

JulienPalard commented Nov 7, 2020

Copy link

Copy Markdown

Member Author

Rebase on top of master, this is used since a few month in production and works, so I'll merge this soon.

All reactions

Sorry, something went wrong.

Uh oh!

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

JulienPalard removed the DO-NOT-MERGE label

Nov 7, 2020

JulienPalard merged commit ee2549c into python:master

Nov 7, 2020

bedevere-bot removed the awaiting merge label

Nov 7, 2020

shihai1991 added a commit to shihai1991/cpython that referenced this pull request

Nov 7, 2020


          Merge remote-tracking branch 'origin/master' into bpo_41073_add_types…

2d72953

…lots1

* origin/master: (80 commits)
  bpo-42282: Fold constants inside named expressions (pythonGH-23190)
  bpo-41028: Doc: Move switchers to docsbuild-scripts. (pythonGH-20969)
  bpo-42133: update parts of the stdlib to fall back to `__spec__.loader` when `__loader__` is missing (python#22929)
  Remove outdated reference to pywin32 from platform module (pythonGH-22005)
  bpo-41832: PyType_FromModuleAndSpec() now accepts NULL tp_doc (pythonGH-23123)
  Minor grammar edits for the descriptor howto guide (GH-python#23175)
  bpo-42179: Doc/tutorial: Remove mention of __cause__ (pythonGH-23162)
  bpo-26389: Allow passing an exception object in the traceback module (pythonGH-22610)
  bpo-42260: PyConfig_Read() only parses argv once (pythonGH-23168)
  bpo-42260: Add _PyConfig_FromDict() (pythonGH-23167)
  bpo-41877 Check for asert, aseert, assrt in mocks (pythonGH-23165)
  [docs] fix wrongly named AsyncContextDecorator (pythonGH-23164)
  bpo-42262: Add Py_NewRef() and Py_XNewRef() (pythonGH-23152)
  bpo-42266: Handle monkey-patching descriptors in LOAD_ATTR cache (pythonGH-23157)
  bpo-40816 Add AsyncContextDecorator class (pythonGH-20516)
  bpo-42260: Add _PyInterpreterState_SetConfig() (pythonGH-23158)
  Disable peg generator tests when building with PGO (pythonGH-23141)
  bpo-1635741: _sqlite3 uses PyModule_AddObjectRef() (pythonGH-23148)
  bpo-1635741: Fix PyInit_pyexpat() error handling (pythonGH-22489)
  bpo-42260: Main init modify sys.flags in-place (pythonGH-23150)
  ...

adorilson pushed a commit to adorilson/cpython that referenced this pull request

Mar 13, 2021


          bpo-41028: Doc: Move switchers to docsbuild-scripts. (pythonGH-20969)

b947ec9

JulienPalard deleted the move-switchers branch

October 9, 2021 07:30

ned-deily added needs backport to 3.8 labels

Jan 2, 2022

miss-islington commented Jan 2, 2022

Copy link

Copy Markdown

Contributor

Thanks @JulienPalard for the PR 🌮🎉.. I'm working now to backport this PR to: 3.9.
🐍🍒⛏🤖

All reactions

Sorry, something went wrong.

Uh oh!

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

miss-islington commented Jan 2, 2022

Copy link

Copy Markdown

Contributor

Thanks @JulienPalard for the PR 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

All reactions

Sorry, something went wrong.

Uh oh!

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

bedevere-bot commented Jan 2, 2022

Copy link

Copy Markdown

GH-30343 is a backport of this pull request to the 3.9 branch.

All reactions

Sorry, something went wrong.

Uh oh!

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

bedevere-bot removed the needs backport to 3.9 label

Jan 2, 2022

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request

Jan 2, 2022


          bpo-41028: Doc: Move switchers to docsbuild-scripts. (pythonGH-20969)

2e88965

(cherry picked from commit ee2549c)

Co-authored-by: Julien Palard <[email protected]>

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request

Jan 2, 2022


          bpo-41028: Doc: Move switchers to docsbuild-scripts. (pythonGH-20969)

17515c9

(cherry picked from commit ee2549c)

Co-authored-by: Julien Palard <[email protected]>

bedevere-bot removed the needs backport to 3.8 label

Jan 2, 2022

bedevere-bot commented Jan 2, 2022

Copy link

Copy Markdown

GH-30344 is a backport of this pull request to the 3.8 branch.

All reactions

Sorry, something went wrong.

Uh oh!

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

ned-deily pushed a commit that referenced this pull request

Jan 2, 2022


          bpo-41028: Doc: Move switchers to docsbuild-scripts. (GH-20969) (GH-3…

b28b022

…0343)

(cherry picked from commit ee2549c)

Co-authored-by: Julien Palard <[email protected]>

ambv pushed a commit that referenced this pull request

Feb 17, 2022


          bpo-41028: Doc: Move switchers to docsbuild-scripts. (GH-20969) (GH-3…

4c48cac

…0344)

(cherry picked from commit ee2549c)

Co-authored-by: Julien Palard <[email protected]>

Reviewers

ned-deily

ned-deily approved these changes

Uh oh!

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

Assignees

No one assigned

Labels

docs

Documentation in the Doc dir

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.

5 participants

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.

GeezerVison

Conversation

JulienPalard commented Jun 18, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JulienPalard commented Jun 19, 2020

Uh oh!

JulienPalard commented Jun 19, 2020

Uh oh!

JulienPalard commented Jun 21, 2020

Uh oh!

ned-deily left a comment

Choose a reason for hiding this comment

Uh oh!

JulienPalard commented Nov 7, 2020

Uh oh!

miss-islington commented Jan 2, 2022

Uh oh!

miss-islington commented Jan 2, 2022

Uh oh!

bedevere-bot commented Jan 2, 2022

Uh oh!

bedevere-bot commented Jan 2, 2022

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

JulienPalard commented Jun 18, 2020 •

edited

Loading

Uh oh!

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