-
Notifications
You must be signed in to change notification settings - Fork 431
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
added sphinxcontrib-django to extensions #736
Conversation
@@ -8,4 +8,3 @@ | |||
|
|||
.. automodule:: django_celery_beat.models | |||
:members: | |||
:undoc-members: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This directive causes the fields documented by the extension to be listed twice
The only problem that I see is that this dependency does not yet support Django v5 and we want to put out a release that does support Dj5. Could you please check to see if that will present problems? |
Setting the minimum version of Django to 5.0 did not cause any problems installing or running this for me, and since it's only a docs dependency I assume it shouldn't affect users directly. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this patch @mfosterw, while the former patch to this, does look informative enough, the latter shows great ease of use for developers. That said we can only push for sphinx-doc/sphinxcontrib-django#66 to get merged. Once again thank you @cclauss, @mfosterw. Good job! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice, thank you!
Closes #735. To test this, first install the new dependency with
pip install requirements/docs.txt
and then build the docs normally.