Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sphinxcontrib-django for documentation #4859

Open
mfosterw opened this issue Feb 13, 2024 · 0 comments
Open

Add sphinxcontrib-django for documentation #4859

mfosterw opened this issue Feb 13, 2024 · 0 comments

Comments

@mfosterw
Copy link
Contributor

Description

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants