Opened 49 minutes ago

Last modified 24 minutes ago

#37157 assigned Cleanup/optimization

Add "htmllive" for docs development (sphinx-autobuild)

Reported by: Mike Edmunds Owned by: Mike Edmunds
Component: Documentation Version: 6.0
Severity: Normal Keywords: sphinx
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

CPython's docs Makefile includes an ​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 ​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.)

Change History (1)

comment:1 by Mike Edmunds, 24 minutes ago

Owner: set to Mike Edmunds
Status: new → assigned
Note: See TracTickets for help on using tickets.
Back to Top