Hi all, I’m trying to get auto documentation using...
# ask-community
l
Hi all, I’m trying to get auto documentation using Sphinx from docstrings. The code base uses a lot of task decorators. I’ve done some research, but all those answers are ~ a year old, so not sure if things have not developed further. Ideally. I’d like to have a nice sphinx autogenerated documentation using `automodule`directive. Based on what I’ve found here and here. I can now get nice documentation, provided I define a function manually using
autofunction
directive (tedious and not ideal). I can achieve a similar behaviour when I define the task using class and run() method (would require a lot of changes in the code base, so not ideal too), and I’ve also came across a plugin for celery…. So my question is: is there anything else I can do with present version of prefect to set up sphinx documentation using
automodule
? If so, could you point me to the right direction/provide me with a code snippet? If not do you plan on making something like prefect-sphinx plugin, that would allow this functionality? Thanks in advance for any comment/suggestion!
k
Hey @Lukáš Pravda, chatted the team and the feedback was you open a Github issue so we can track it and discuss it there. I think everything you posted here is right though, and I don’t think I’ve seen anyone do the
automodule
successfully in this channel but we’ll see if the community can chime in
l
will open a GH issue, then. Thanks! 🙂