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

added sphinxcontrib-django to extensions #736

Merged
merged 2 commits into from Mar 3, 2024

Conversation

mfosterw
Copy link
Contributor

Closes #735. To test this, first install the new dependency with pip install requirements/docs.txt and then build the docs normally.

@@ -8,4 +8,3 @@

.. automodule:: django_celery_beat.models
:members:
:undoc-members:
Copy link
Contributor Author

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

@Nusnus Nusnus requested a review from cclauss February 25, 2024 10:21
@cclauss
Copy link
Contributor

cclauss commented Feb 25, 2024

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?

@mfosterw
Copy link
Contributor Author

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.

@cclauss cclauss self-assigned this Feb 26, 2024
Copy link
Contributor

@cclauss cclauss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@50-Course
Copy link

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!

@auvipy auvipy self-requested a review February 29, 2024 12:45
Copy link
Member

@Nusnus Nusnus left a 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!

@Nusnus Nusnus merged commit 3d82c8a into celery:main Mar 3, 2024
17 checks passed
@mfosterw mfosterw deleted the sphinxcontrib-django branch March 3, 2024 17:45
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 this pull request may close these issues.

Add sphinxcontrib-django to docs extensions
4 participants