You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
I'd like to have autosummary be able to recognize autodoc documenters other than the built-in ones. E.g. celery tasks. Celery brings it's own documenter [1] in an extension, but the typ of task is not recognized.
@epruesse@tk0miya I would like to make some progress on this issue. I could provide a PR myself but don't want to duplicate efforts if there is an existing PR already.
epruesse
changed the title
Allow custom documentes in autosummary
Allow custom documents in autosummary
Aug 30, 2021
epruesse
changed the title
Allow custom documents in autosummary
Allow custom documenters in autosummary
Aug 30, 2021
@tk0miya@epruesse Just a friendly reminder if you could provide a short feedback if there has been any PR or approach already for the current issue (see my previous response).
Is your feature request related to a problem? Please describe.
I'd like to have
autosummary
be able to recognizeautodoc
documenters other than the built-in ones. E.g.celery
tasks. Celery brings it's own documenter [1] in an extension, but thetyp
oftask
is not recognized.[1] http://docs.celeryproject.org/en/latest/_modules/celery/contrib/sphinx.html#TaskDocumenter
Describe the solution you'd like
The code below could be turned into a loop with configurable inputs:
sphinx/sphinx/ext/autosummary/generate.py
Lines 192 to 198 in d501bc1
The list could be automatically, or manually, extended with further documenters, via
conf.py
or from other extensions.Describe alternatives you've considered
conf.py
(The last would be great - although a question is how to know what is available when adapting the jinja template)
The text was updated successfully, but these errors were encountered: