Switch to sphinx_autodoc_typehints for doc #93
Merged
+335
−285
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
greschd
force-pushed
the
maint/update_lock
branch
from
42d06c1 to
5645497
Compare
greschd
changed the title
roosre
approved these changes
Oct 10, 2022
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.
See discussion in ansys/pyansys-dev-guide#187
While using
sphinx.ext.autodoc.typehintsworked for us, followingthe common approach seems superior.
Remove the
_autosummarydirectory duringmake(.bat) cleaninthe documentation. This directory is auto-generated, and not
removing it can cause a rebuild of the documentation to be
incomplete.
Use
functools.wrapsfor the mapping create method, to get rid ofdoc build warnings.