Version 1 (modified by mrts, 10 years ago) (diff)


Part of DjangoSpecifications

Producing HTML and PDF output from docs source

This is useful for both offline documentation and reading branch documentation that is usually not available on the web.

#528 is a long-standing ticket that has a basic implementation. A better (perhaps?) approach is proposed below.


Generating offline documentation should work as follows:

  • there is a command builddocs that can be called from either or
  • the converter tries to make the documentation look similar to web docs by
  • the inter-page links should be converted to make them work properly (by extending the docutils classes)
  • less important: external images from can be retrieved and image links converted accordingly (--with-images option perhaps?)
Back to Top