sphinx-apidoc vs autosummary

Viewed 2312

I'm running into a bit of brick wall trying to work out the best way to implement automatic documentation generation for a Django project

my project structure is similar to the following:

myproj/           # project root
|- docs/          # docs root
|- myproj/        # package root
   |- app1/
   |- app2/
   |- app3/
   utils.py
   ...

I would like to automatically generate documentation for everything under the package root directory- and initially started using sphinx-apidoc, but then read something that implied I should be using autosummary instead and have not been able to find any information outlining what the difference between these two options is.

1 Answers
Related