We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Is your feature request related to a problem? Please describe. If I use typehints like this, I get the same result as expected from the documentation.
in code:
def func(value: int | str) pass
in documentation:
value (int | str) - description about value.
But adding None converts it to a hard-to-read form. in code:
None
def func(value: int | str | None = None) pass
value (Optional[Union[int, str]]) - description about value.
I think the output should look like this.
value (int | str | None) - description about value.
Does Sphinx already have these features? If not, it would be nice if Sphinx implemented such a feature.
The text was updated successfully, but these errors were encountered:
This has been implemented in the sphinx-immaterial theme:
https://jbms.github.io/sphinx-immaterial/apidoc/python/index.html#confval-python_transform_type_annotations_pep604
You might consider creating a pr to upstream that feature into sphinx itself.
Sorry, something went wrong.
No branches or pull requests
Is your feature request related to a problem? Please describe.
If I use typehints like this, I get the same result as expected from the documentation.
in code:
in documentation:
But adding
None
converts it to a hard-to-read form.in code:
in documentation:
I think the output should look like this.
Does Sphinx already have these features? If not, it would be nice if Sphinx implemented such a feature.
The text was updated successfully, but these errors were encountered: