Skip to content

Conversation

@mattsb42-aws
Copy link
Member

@mattsb42-aws mattsb42-aws commented May 2, 2018

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 for intersphinx_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.

@mattsb42-aws mattsb42-aws requested review from david-koenig and praus May 2, 2018 01:41
@mattsb42-aws mattsb42-aws changed the base branch from DELETE-10 to master May 2, 2018 18:20
@mattsb42-aws mattsb42-aws merged commit 7e253d5 into aws:master May 2, 2018
@mattsb42-aws mattsb42-aws deleted the docstrings branch May 2, 2018 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants