Open
Conversation
Contributor
Author
|
I didn't touch any Python code here -- the |
The following are not documented in this commit: - `sphinx.testing.fixtures.test_params` - `sphinx.testing.fixtures.shared_result` - `sphinx.testing.fixtures._shared_result_cache` - `sphinx.testing.restructuredtext.parse` - `sphinx.testing.util.assert_node`
pradyunsg
force-pushed
the
feature-testing-docs
branch
from
7f46de9 to
e2f070e
Compare
jdillard
reviewed
Dec 22, 2025
Member
|
PR preview build of the page: https://sphinx--14205.org.readthedocs.build/en/14205/extdev/testing.html |
jdillard
reviewed
Dec 22, 2025
AA-Turner
reviewed
Dec 30, 2025
Comment on lines
-4
to
-6
| .. py:module:: sphinx.testing | ||
| :synopsis: Utility functions and pytest fixtures for testing. | ||
|
|
Contributor
Author
There was a problem hiding this comment.
What's the question here?
Member
There was a problem hiding this comment.
Sorry, just why has this been deleted
Contributor
Author
There was a problem hiding this comment.
No particular reason
Co-authored-by: Jared Dillard <jared.dillard+github@gmail.com>
…hinx-doc#14024) Co-authored-by: Jean-François B. <2589111+jfbu@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Formerly, PDF rendering crashed for inputs of more than about 1350 codelines either from a code-block, or from a literal include, when this literal include used the sphinxVerbatim and not the sphinxalltt route. The fix goes via novel mark-up which is applied in case the literally included file or code-block contains more than 500 codelines. Then chunks of 500 consecutive source codelines are rendered using: sphinxLongVerbatimFirst, sphinxLongVerbatimMiddle, and sphinxLongVerbatimLast. Efforts have been devoted for line numbering and emphasizing to not be modified, and (if so configured) for bottom captions to appear where expected. It was needed to (to cut into smaller pieces and) modify in a very limited manner the legacy sphinxVerbatim which is still used for up to 500 codelines, which corresponds to about 10 a4-sized pages, if document is with default pointsize and margins. Hopefully no consequences will arise from these changes. Known issue: in the unlikely event a pagebreak happens exactly after a chunk of 500 code lines, the continuation hints usually printed at bottom and top of pages are omitted.
…tly to PDF if using ``literalinclude`` (sphinx-doc#14066) They can not attow come from code-blocks, having been replaced during Docutils/Sphinx processing with spaces before ending in the .tex file. But they may originate from literalinclude directive. Known limitation: only "top-level" TABs will obey tab stops. Indeed, TABs ending inside the Pygmentize highlighting macro \PYG would cause breakage if the fancyvrb.sty method for them to obey tab stops was put at work. So Sphinx modifies \PYG to let TABs in such location get converted to a fixed number (default 8) of spaces. Close sphinx-doc#14064
Contributor
Author
|
@AA-Turner it looks like your rebase/merge went wrong here? |
Member
|
Yes, sorry, not quite sure what happened. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 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.
Purpose
Add more details to the documentation page of
sphinx.testing.Some things are somewhat intentionally not documented right now, to keep the first iteration of this somewhat tractable for a 3am job. 😅
sphinx.testing.fixtures.test_params-- this was a bit tricky to describe, so I decided to defer it.sphinx.testing.fixtures.shared_result-- this was a bit tricky to describe, so I decided to defer it.sphinx.testing.fixtures._shared_result_cache-- private name.sphinx.testing.restructuredtext.parse-- I got tired. 🙃sphinx.testing.util.assert_node-- not exported in__all__.References
PS: I did use GitHub Copilot as a part of my process for writing these docs. I did rewrite basically everything but some mistakes might have happened downstream of that usage. 😅