Skip to content
New issue

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

Question: remove module name from path #25

Open
jeertmans opened this issue May 24, 2023 · 2 comments
Open

Question: remove module name from path #25

jeertmans opened this issue May 24, 2023 · 2 comments

Comments

@jeertmans
Copy link

Hello,

First, thanks for your work!

Do you know if it's possible to remove the full name from a class or function reference?

As shown below, it's even more bizarre that the name is shortened in the PARAMETERS sections, but not in the function signature.

I'd like to have Point everywhere, instead of differt2d.geometry.Point. The same applies for others.

I have set the add_module_names variable to False in conf.py, but it doesn't work (I guess it's because we are not using autodoc here).

image

@davidselassie
Copy link

The Sphinx config python_use_unqualified_type_names = True seems to do what you request for me. It looks like sphinx-autodoc2 only generates py::function directives and Sphinx itself decides how to render them.

https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-python_use_unqualified_type_names

@jeertmans
Copy link
Author

Thanks for help @davidselassie, I will test that when I can :)

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

No branches or pull requests

2 participants