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 to docs extensions #735

Closed
mfosterw opened this issue Feb 20, 2024 · 0 comments · Fixed by #736
Closed

Add sphinxcontrib-django to docs extensions #735

mfosterw opened this issue Feb 20, 2024 · 0 comments · Fixed by #736

Comments

@mfosterw
Copy link
Contributor

Reasoning:

Right now the reference docs for models do nothing but list the fields while providing a generic description of a django field, and you can only really figure out what the fields do from the admin or by reading the source code. sphinxcontrib-django is an extension for autodoc which automatically documents django models based on their help_text. As you can see, before:

Screenshot 2024-02-20 at 5 53 32 PM

(ugly, useless) vs after:

Screenshot 2024-02-20 at 5 53 48 PM

(beautiful, informative). While I think the examples are good, there are some fields which aren't mentioned there that are nice to have described in the api reference. Obviously in order to provide the image reference I had to implement this, so I will open a pull request so others can check it out and browse the docs generated with the extension.

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

Successfully merging a pull request may close this issue.

1 participant