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

Jump to bottom

Fix wrongly indented blocks in the documentation #110631

Closed
ezio-melotti opened this issue Oct 10, 2023 · 1 comment
Closed

Fix wrongly indented blocks in the documentation #110631

ezio-melotti opened this issue Oct 10, 2023 · 1 comment
Assignees
@ezio-melotti
Labels
3.11 bug and security fixes 3.12 bugs and security fixes 3.13 new features, bugs and security fixes docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error

Comments

@ezio-melotti
Copy link
Member

ezio-melotti commented Oct 10, 2023 •
edited by bedevere-app bot

Bug report

In the documentation there are several blocks that are indented incorrectly but don't produce errors when the documentation is built. Two common mistakes wrap the misindented block into an additional blockquote or definition list, causing extra indentation in the rendered output but no other visible problems (at least with the current theme).

This is a follow-up of python/devguide#1178 and the linked PRs that fixed a list of similar issues in the devguide repository.

I'm working on a few PRs that fix these errors in the docs.

Linked PRs
@ezio-melotti ezio-melotti added type-bug An unexpected behavior, bug, or error docs Documentation in the Doc dir 3.11 bug and security fixes 3.12 bugs and security fixes 3.13 new features, bugs and security fixes labels Oct 10, 2023
@ezio-melotti ezio-melotti self-assigned this Oct 10, 2023
@bedevere-app bedevere-app bot mentioned this issue Oct 10, 2023
Merged
@ezio-melotti ezio-melotti mentioned this issue Oct 10, 2023
Closed
6 tasks
@bedevere-app bedevere-app bot mentioned this issue Oct 10, 2023
Merged
AlexWaygood pushed a commit that referenced this issue Oct 10, 2023
@hugovk
gh-110631: Set three-space indents for reST in EditorConfig (#110635)
66a9b10 
Set three-space indents in EditorConfig
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 10, 2023
@hugovk @miss-islington
pythongh-110631: Set three-space indents for reST in EditorConfig (py…
40de936 
…thonGH-110635)

Set three-space indents in EditorConfig
(cherry picked from commit 66a9b10)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
This was referenced Oct 10, 2023
Merged
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 10, 2023
@hugovk @miss-islington
pythongh-110631: Set three-space indents for reST in EditorConfig (py…
2e8b456 
…thonGH-110635)

Set three-space indents in EditorConfig
(cherry picked from commit 66a9b10)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
AlexWaygood pushed a commit that referenced this issue Oct 10, 2023
@miss-islington @hugovk
[3.11] gh-110631: Set three-space indents for reST in EditorConfig (G…
4b67878 
…H-110635) (#110638)

gh-110631: Set three-space indents for reST in EditorConfig (GH-110635)

Set three-space indents in EditorConfig
(cherry picked from commit 66a9b10)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
AlexWaygood pushed a commit that referenced this issue Oct 10, 2023
@miss-islington @hugovk
[3.12] gh-110631: Set three-space indents for reST in EditorConfig (G…
5b168fd 
…H-110635) (#110637)

gh-110631: Set three-space indents for reST in EditorConfig (GH-110635)

Set three-space indents in EditorConfig
(cherry picked from commit 66a9b10)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk pushed a commit that referenced this issue Oct 11, 2023
@ezio-melotti
gh-110631: fix wrong indentation in the Doc/whatsnew dir (#110632)
3dd593e 
Fix wrong indentation in the Doc/whatsnew dir.
@bedevere-app bedevere-app bot mentioned this issue Oct 11, 2023
Merged
ezio-melotti added a commit to ezio-melotti/cpython that referenced this issue Oct 11, 2023
@ezio-melotti
pythongh-110631: fix wrong indentation in the Doc/whatsnew dir (pyt…
ab25de2 
…hon#110632)

Fix wrong indentation in the Doc/whatsnew dir.

(cherry picked from commit 3dd593e)
@bedevere-app bedevere-app bot mentioned this issue Oct 11, 2023
Merged
ezio-melotti added a commit to ezio-melotti/cpython that referenced this issue Oct 11, 2023
@ezio-melotti
pythongh-110631: fix wrong indentation in the Doc/whatsnew dir (pyt…
a943a4b 
…hon#110632)

Fix wrong indentation in the Doc/whatsnew dir.

(cherry picked from commit 3dd593e)
@bedevere-app bedevere-app bot mentioned this issue Oct 11, 2023
Merged
hugovk pushed a commit that referenced this issue Oct 11, 2023
@ezio-melotti
[3.12] gh-110631: fix wrong indentation in the Doc/whatsnew dir (GH…
1ea4cb1 
…-110632) (#110690)

fix wrong indentation in the `Doc/whatsnew` dir (#110632)
hugovk pushed a commit that referenced this issue Oct 11, 2023
@ezio-melotti
[3.11] gh-110631: fix wrong indentation in the Doc/whatsnew dir (GH…
a8b2d12 
…-110632) (#110691)

fix wrong indentation in the `Doc/whatsnew` dir (#110632)
This was referenced Oct 11, 2023
Merged
Merged
ezio-melotti added a commit that referenced this issue Oct 11, 2023
@ezio-melotti
gh-110631: Fix reST indentation in Doc/library (#110685)
bb7923f 
Fix wrong indentation in the Doc/library dir.
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 11, 2023
@ezio-melotti @miss-islington
pythongh-110631: Fix reST indentation in Doc/library (pythonGH-110685)
f7b74df 
Fix wrong indentation in the Doc/library dir.
(cherry picked from commit bb7923f)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@bedevere-app bedevere-app bot mentioned this issue Oct 11, 2023
Merged
ezio-melotti added a commit to ezio-melotti/cpython that referenced this issue Oct 11, 2023
@ezio-melotti
[3.11] pythongh-110631: Fix reST indentation in Doc/library (python…
809a677 
…GH-110685)

Fix wrong indentation in the Doc/library dir..
(cherry picked from commit bb7923f)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@bedevere-app bedevere-app bot mentioned this issue Oct 11, 2023
Merged
ezio-melotti added a commit that referenced this issue Oct 11, 2023
@ezio-melotti
gh-110631: Fix reST indentation (#110724)
718391f 
* Fix wrong indentation in the other dirs.

* Fix more wrong indentation.
ezio-melotti added a commit to ezio-melotti/cpython that referenced this issue Oct 11, 2023
@ezio-melotti
[3.12] pythongh-110631: Fix reST indentation (pythonGH-110724)
e0baea8 
* Fix wrong indentation in the other dirs.

* Fix more wrong indentation..
(cherry picked from commit 718391f)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@bedevere-app bedevere-app bot mentioned this issue Oct 11, 2023
Merged
ezio-melotti added a commit to ezio-melotti/cpython that referenced this issue Oct 11, 2023
@ezio-melotti
[3.11] pythongh-110631: Fix reST indentation (pythonGH-110724)
9d36f00 
* Fix wrong indentation in the other dirs.

* Fix more wrong indentation..
(cherry picked from commit 718391f)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@bedevere-app bedevere-app bot mentioned this issue Oct 11, 2023
Merged
ezio-melotti added a commit that referenced this issue Oct 11, 2023
@ezio-melotti
gh-110631: Fix reST indentation in Doc/reference (#110708)
41d8ec5 
Fix wrong indentation in the Doc/reference dir.
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 11, 2023
@ezio-melotti @miss-islington
pythongh-110631: Fix reST indentation in Doc/reference (pythonGH-11…
b850d11 
…0708)

Fix wrong indentation in the Doc/reference dir.
(cherry picked from commit 41d8ec5)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@bedevere-app bedevere-app bot mentioned this issue Oct 11, 2023
Merged
ezio-melotti added a commit to ezio-melotti/cpython that referenced this issue Oct 11, 2023
@ezio-melotti
[3.11] pythongh-110631: Fix reST indentation in Doc/reference (pyth…
30c8583 
…onGH-110708)

Fix wrong indentation in the Doc/reference dir..
(cherry picked from commit 41d8ec5)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@bedevere-app bedevere-app bot mentioned this issue Oct 11, 2023
Merged
ezio-melotti added a commit that referenced this issue Oct 11, 2023
@miss-islington @ezio-melotti
[3.12] gh-110631: Fix reST indentation in Doc/library (GH-110685) (#…
cae968b 
…110736)

gh-110631: Fix reST indentation in `Doc/library` (GH-110685)

Fix wrong indentation in the Doc/library dir.
(cherry picked from commit bb7923f)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
ezio-melotti added a commit that referenced this issue Oct 11, 2023
@ezio-melotti
[3.11] gh-110631: Fix reST indentation in Doc/library (GH-110685) (#…
07471cd 
…110737)

* [3.11] gh-110631: Fix reST indentation in `Doc/library` (GH-110685)

Fix wrong indentation in the Doc/library dir..
(cherry picked from commit bb7923f)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

* Fix merge glitch.
ezio-melotti added a commit that referenced this issue Oct 11, 2023
@ezio-melotti
[3.12] gh-110631: Fix reST indentation (GH-110724) (#110738)
7d5a982 
* Fix wrong indentation in the other dirs.

* Fix more wrong indentation..
(cherry picked from commit 718391f)
ezio-melotti added a commit that referenced this issue Oct 11, 2023
@ezio-melotti
[3.11] gh-110631: Fix reST indentation (GH-110724) (#110739)
90b2620 
* Fix wrong indentation in the other dirs.

* Fix more wrong indentation..
(cherry picked from commit 718391f)
ezio-melotti added a commit that referenced this issue Oct 11, 2023
@miss-islington @ezio-melotti
[3.12] gh-110631: Fix reST indentation in Doc/reference (GH-110708) (…
dbbe0ee 
…#110740)

gh-110631: Fix reST indentation in `Doc/reference` (GH-110708)

Fix wrong indentation in the Doc/reference dir.
(cherry picked from commit 41d8ec5)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
ezio-melotti added a commit that referenced this issue Oct 12, 2023
@ezio-melotti
[3.11] gh-110631: Fix reST indentation in Doc/reference (GH-110708) (…
eb492d3 
…#110741)

Fix wrong indentation in the Doc/reference dir..
(cherry picked from commit 41d8ec5)
@ezio-melotti ezio-melotti mentioned this issue Oct 12, 2023
Open
@ezio-melotti
Copy link
Member Author

All the issues should now be fixed, merged, and backported. The next step is adding the checker I wrote to detect these issues to sphinx-lint:

Thanks to @pradyunsg, @hugovk, and @AlexWaygood for helping me with this issue/PRs!

@bedevere-app bedevere-app bot mentioned this issue Oct 15, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ezio-melotti ezio-melotti

Labels
3.11 bug and security fixes 3.12 bugs and security fixes 3.13 new features, bugs and security fixes docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ezio-melotti