Opened 5 years ago

Closed 5 years ago

#14654 closed (wontfix)

Cannot make documentation in single HTML file format

Reported by: anonymous Owned by: nobody
Component: Documentation Version: master
Severity: Keywords: documentation, make, singlehtml
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:


Building the latest trunk documentation in single HTML format fails with:

~/django-trunk/docs$ make singlehtml
sphinx-build -b singlehtml -d _build/doctrees   . _build/singlehtml
Making output directory...
Running Sphinx v0.6.6

Sphinx error:
Builder name singlehtml not registered
make: *** [singlehtml] Error 1

Change History (1)

comment:1 Changed 5 years ago by ramiro

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Resolution set to wontfix
  • Status changed from new to closed

Sphinx 0.6.6 doesn't support that output format as it doesn't ship the corresponding builder. I think it was added in 1.0.

We announce support for 0.6.x and 1.0 and generation of our docs in the basic html and latex/pdf outputs works with 0.6.x, but the docs/Makefile file we ship is one generated by Sphinx 1.0.x that's the reason you see singlehtml among the possible outputs formats (along with another 1.0-only ones like epub).

Jacob has expressed he would be OK with completely dropping support of Sphinx < 1.0 and we will possibly do so before 1.3.

Closing this ticket because there isn't much we can do about this. I'd suggest to upgrade to Sphinx 1.0.x.

Note: See TracTickets for help on using tickets.
Back to Top