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

Align documentation generation to Django #1634

Open
pauloxnet opened this issue Sep 27, 2024 · 0 comments
Open

Align documentation generation to Django #1634

pauloxnet opened this issue Sep 27, 2024 · 0 comments
Labels
dependencies Pull requests that update a dependency file DjangoCon 🦄 docs

Comments

@pauloxnet
Copy link
Member

pauloxnet commented Sep 27, 2024

To maintain compatibility, we want to align documentation generation with Django's pipeline.

Since in the Django documentation requirements we are using the latest available version of Sphinx [1] we agreed with @bmispelon that it is safe to also update the version we use on the site to the latest available in order to be aligned with the pipeline that generates the Django documentation.

We should also align the commands and options used to generate documentation between what happens in the Django pipeline and what happens in the DjangoProject commands.

In the Django repository action the documentation is not generated [2], but only the spelling builder is invoked to check typos in the documentation, so there are no options to align here.

[1] https://github.com/django/django/blob/main/docs/requirements.txt#L2
[2] https://github.com/django/django/blob/main/.github/workflows/docs.yml

@pauloxnet pauloxnet added docs dependencies Pull requests that update a dependency file DjangoCon 🦄 labels Sep 27, 2024
@pauloxnet pauloxnet changed the title Update Sphinx and docutils to the latest version Align Sphinx usage to Django pipeline Oct 8, 2024
@pauloxnet pauloxnet changed the title Align Sphinx usage to Django pipeline Align documentation generation to Django Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file DjangoCon 🦄 docs
Projects
None yet
Development

No branches or pull requests

1 participant