Add module name rewrite configuration option #474
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
This adds a configuration option that allows the user to rewrite module names if needed. Resolves tox-dev#473. Note that we also rewrite the names of `_io` and `typing_extensions` internally. One benefit of this hook is that if other similar rewrites are needed, users will be able to immediately add them without having to patch sphinx_autodoc_typehints itself. One disadvantage is that by default, having a function in the config prevents caching. I think this can be handled with the following slightly inelegant hack: ```py class ModuleNameRewriteHook: version: int def __eq__(self, other): return type(self) == type(other) and self.version == other.version def __init__(self): self.version = 2 def __call__(self, module): # logic here # Make sure to bump version if you edit this so that sphinx will rerun. return module typehints_fixup_module_name = ModuleNameRewriteHook ``` See sphinx-doc/sphinx#12300.
hoodmane
force-pushed
the
fixup-module-name-hook
branch
from
8067650 to
e74cc58
Compare
for more information, see https://pre-commit.ci
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 adds a configuration option that allows the user to rewrite module names if needed. Resolves #473. Note that we also rewrite the names of
_ioandtyping_extensionsinternally. One benefit of this hook is that if other similar rewrites are needed, users will be able to immediately add them without having to patch sphinx_autodoc_typehints itself.One disadvantage is that by default, having a function in the config prevents caching. I think this can be handled with the following slightly inelegant hack:
See sphinx-doc/sphinx#12300.