#37157: Add "htmllive" for docs development (sphinx-autobuild)
-------------------------------------+-------------------------------------
Reporter: Mike Edmunds | Type:
| Cleanup/optimization
Status: new | Component:
| Documentation
Version: 6.0 | Severity: Normal
Keywords: sphinx | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
CPython's docs Makefile includes an
[https://github.com/python/cpython/blob/e60c42dc3f5a8dd9b10bc9a8a028ef2765469650/Doc/Makefile#L156-L159
"htmllive"] target that's ''extremely'' helpful while working on docs. It:
- Builds the docs
- Opens a web browser on the local docs build (like Django's "make
htmlview")
- Watches the docs source and rebuilds after any changes
- Hot reloads updated pages
All of this is via [https://github.com/sphinx-doc/sphinx-autobuild sphinx-
autobuild].
We should borrow that "htmllive" target for Django's docs/Makefile.
(I haven't investigated whether sphinx-autobuild works on Windows. If so,
we'd also add it in docs/make.bat.)
--
Ticket URL: <https://code.djangoproject.com/ticket/37157>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion visit
https://groups.google.com/d/msgid/django-updates/0107019eb314adad-ae9afb0c-dea7-4047-8578-ff2cce33ebb1-000000%40eu-central-1.amazonses.com.
