Documentation gardening. #88
Merged
Conversation
This file contains 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
- conf.py: Use default autodoc flags, and prepare for Sphinx 2.0. - conf.py: Read the correct version number for transaction. - conf.py: Add intersphinx mappings for stdlib and ZODB. - conf.py: Make the default role be object references, enabling `IThing` instead of :class:`IThing` for prettier docstrings. - interfaces.py: Cross references. - interfaces.py: ITransaction: Remove outdated docs about using a single transaction object more than one time. That doesn't work anymore. - interfaces.py: Simplify copied documentation, especially for the various ITransaction hook methods. - convenience.rst, integrations.rst: Fix compatibility with Sphinx 2 and straighten adornments Previously they raised "TypeError: '_traversal_list' object is not reversible" from sphinx.util.nodes line 151 apply_source_workaround.
|
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This was sparked because I noticed that the classes that were newly documented in #86 aren't actually showing up on transaction.readthedocs.io, despite the new build that occurred because of in #87. I didn't see anything in the logs, but we'll see what happens after this.
conf.py: Use default autodoc flags, and prepare for Sphinx 2.0.
conf.py: Read the correct version number for transaction.
conf.py: Add intersphinx mappings for stdlib and ZODB.
conf.py: Make the default role be object references, enabling
IThinginstead of :class:IThingfor prettier docstrings.interfaces.py: Cross references.
interfaces.py: ITransaction: Remove outdated docs about using a single transaction object more than one time. That doesn't work anymore.
interfaces.py: Simplify copied documentation, especially for the various ITransaction hook methods.
api.rst: DRY, use the default flags.
convenience.rst, integrations.rst: Fix compatibility with Sphinx 2 and straighten adornments
Previously they raised "TypeError: '_traversal_list' object is not reversible"
from sphinx.util.nodes line 151 apply_source_workaround.