[Django] #36474: Add sphinx-autobuild and livehtml command to make file for live reload of the django documentation

10 views
Skip to first unread message

Django

unread,
Jun 22, 2025, 1:07:18 PM6/22/25
to django-...@googlegroups.com
#36474: Add sphinx-autobuild and livehtml command to make file for live reload of
the django documentation
----------------------------+-----------------------------------------
Reporter: Farhan Ali | Type: New feature
Status: new | Component: Documentation
Version: dev | Severity: Normal
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
----------------------------+-----------------------------------------
When writting documentation is really frustrating to go back and rerun the
command to rebuild the documentation and open the browser or refresh the
browser to see the change.
--
Ticket URL: <https://code.djangoproject.com/ticket/36474>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Jun 22, 2025, 3:24:43 PM6/22/25
to django-...@googlegroups.com
#36474: Add sphinx-autobuild and livehtml command to make file for live reload of
the django documentation
-------------------------------+--------------------------------------
Reporter: Farhan Ali | Owner: (none)
Type: New feature | Status: closed
Component: Documentation | Version: dev
Severity: Normal | Resolution: wontfix
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------------------------
Changes (by Natalia Bidart):

* resolution: => wontfix
* status: new => closed

Comment:

Hello Farhan Ali, thank you for your ticket. As I just mentioned on
Discord, you can easily choose to use `sphinx-autobuild` or any other
Sphinx builder by overriding the env variables that the `Makefile`
support:
{{{
SPHINXBUILD=sphinx-autobuild make html
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/36474#comment:1>
Reply all
Reply to author
Forward
0 new messages