docstring cleanup and class reference simplification #52
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
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.
Description of changes:
When I started going through the rendered docs, I realized that Sphinx does not require the full namespace path for custom classes if those classes are defined in this codebase. In light of that, this replaces all of those full namespace paths with just the class name. This results in a much cleaner, more concise, rendered result that still links to the docs for that class.
Note about the change in
conf.py: this is just updating the template that I had started with to a more modern syntax forintersphinx_mapping.http://www.sphinx-doc.org/en/1.5.1/ext/intersphinx.html#confval-intersphinx_mapping
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.