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
The template should include a dependency on sphinxcontrib-django and include it in the extensions in docs/conf.py.
Rationale
sphinx-autodoc is, in my opinion, almost useless on its own for django, especially for models, and at minimum requires extensive configuration to be remotely readable. Also, all the documentation within the code from features like help_text is completely ignored and has to be repeated in the docs. Sphinxcontrib-django does away with all those issues and more, enabling informative documentation with minimal extra effort.
I am not affiliated with this project in any way, I have just become dependent on it for documenting my own cookiecutter project.
The text was updated successfully, but these errors were encountered:
Description
The template should include a dependency on
sphinxcontrib-django
and include it in the extensions indocs/conf.py
.Rationale
sphinx-autodoc
is, in my opinion, almost useless on its own for django, especially for models, and at minimum requires extensive configuration to be remotely readable. Also, all the documentation within the code from features likehelp_text
is completely ignored and has to be repeated in the docs. Sphinxcontrib-django does away with all those issues and more, enabling informative documentation with minimal extra effort.I am not affiliated with this project in any way, I have just become dependent on it for documenting my own cookiecutter project.
The text was updated successfully, but these errors were encountered: