◐ Shell
reader mode source ↗
Skip to content

bpo-36675: Doc: Reveal doctest directives#23620

Merged
JulienPalard merged 2 commits into
python:masterfrom
JulienPalard:doctest
Dec 15, 2020
Merged

bpo-36675: Doc: Reveal doctest directives#23620
JulienPalard merged 2 commits into
python:masterfrom
JulienPalard:doctest

Conversation

@JulienPalard

@JulienPalard JulienPalard commented Dec 2, 2020

Copy link
Copy Markdown
Member

Doctest directive were hidden in HTML and PDF output, this PR show them back.

https://bugs.python.org/issue36675

@JulienPalard

Copy link
Copy Markdown
Member Author

Backport won't be possible, we have older sphinx on older branches.

@JulienPalard

Copy link
Copy Markdown
Member Author

@andresdelfino I see you a lot on the doc those time, though you would be interested in proofreading this :)

@andresdelfino

Copy link
Copy Markdown
Contributor

@JulienPalard JulienPalard merged commit c8a10d2 into python:master Dec 15, 2020
@andresdelfino

Copy link
Copy Markdown
Contributor

@JulienPalard could you check the comment I made? I believe something is missing.

@JulienPalard

Copy link
Copy Markdown
Member Author

@andresdelfino Gladly, but, which comment?

@andresdelfino

Copy link
Copy Markdown
Contributor

@JulienPalard sorry, I thought it was submitted, but I was seeing a draft.

@asottile

asottile commented Jan 5, 2021

Copy link
Copy Markdown
Contributor

This breaks the minimum version of sphinx listed in Docs/conf.py:

needs_sphinx = '1.8'

:no-trim-doctest-flags: was added in sphinx 3.2 whereas the minimum version in Docs/conf.py is 1.8: sphinx-doc/sphinx@784e763

@JulienPalard

Copy link
Copy Markdown
Member Author

@asottile that's right, let's bump this, thanks for noticing!

@asottile

asottile commented Jan 6, 2021

Copy link
Copy Markdown
Contributor

@JulienPalard there's been additional efforts in this release to maintain compatibility with 1.x so there might be competing opinions here

@JulienPalard

JulienPalard commented Jan 6, 2021

Copy link
Copy Markdown
Member Author

Ok so let's discuss this futher in an issue. I'm opening it → https://bugs.python.org/issue42843

@asottile

asottile commented Jan 6, 2021

Copy link
Copy Markdown
Contributor

sounds good -- I only noticed this because it broke the packaging for deadsnakes (on 20.04, 18.04 and 16.04) so I reverted this patch there: deadsnakes/python3.10@f69292e

@JulienPalard

Copy link
Copy Markdown
Member Author

I only noticed this because it broke the packaging for deadsnakes

Sorry for this :(

@asottile

asottile commented Jan 6, 2021

Copy link
Copy Markdown
Contributor

I only noticed this because it broke the packaging for deadsnakes

Sorry for this :(

no big deal, I'm considering dropping the documentation build since it's ~95% of my maintenance and I'm not sure anybody actually uses it.

JulienPalard added a commit to JulienPalard/cpython that referenced this pull request Jan 21, 2021
adorilson pushed a commit to adorilson/cpython that referenced this pull request Mar 13, 2021
@JulienPalard JulienPalard deleted the doctest branch October 9, 2021 07:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants