Document sphinx.testing
#14205
Open
Document sphinx.testing
#14205
+183
−16
Conversation
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
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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. 😅