sphinx-toolbox icon indicating copy to clipboard operation
sphinx-toolbox copied to clipboard

Unable to get `more_autodoc.genericalias` to work.

Open jmlemetayer opened this issue 2 years ago • 2 comments

Description

I am trying to use sphinx_toolbox.more_autodoc.genericalias in my project to document the type alias in my project.

See the PR where I try to integrate it: jmlemetayer/python-inotify-watcher#25

Steps to Reproduce

  1. I have added sphinx_toolbox.more_autodoc.genericalias to the extensions list in conf.py: jmlemetayer/python-inotify-watcher@6a15656

Actual result:

The generated docs does not have any sign of type alias: https://python-inotify-watcher--25.org.readthedocs.build/en/25/_autosummary/inotify_watcher.html

Expected result:

My type alias arfe documented somewhere (eg. UserPathType: Alias of Union[pathlib.Path, str]).

Version

  • Check the RTD build logs: https://readthedocs.org/projects/python-inotify-watcher/builds/17249114/

jmlemetayer avatar Jun 22 '22 15:06 jmlemetayer

I am missing some configuration ?

jmlemetayer avatar Jun 22 '22 15:06 jmlemetayer

Maybe related to the autosummary template overwrite: https://github.com/jmlemetayer/python-inotify-watcher/tree/main/docs/_templates/autosummary

jmlemetayer avatar Jun 22 '22 15:06 jmlemetayer