Changes between Version 9 and Version 10 of DjangoSpecifications/Docs/ConvertingRestToOtherFormats


Ignore:
Timestamp:
03/20/2008 07:16:47 PM (7 years ago)
Author:
mrts
Comment:

New patch that fixes links implemented

Legend:

Unmodified
Added
Removed
Modified
  • DjangoSpecifications/Docs/ConvertingRestToOtherFormats

    v9 v10  
    55This is useful for both offline documentation '''and''' reading branch documentation that is usually not available on the web.
    66
    7 #528 is a long-standing ticket that has a basic implementation. A better (perhaps?) approach is proposed below.
     7#528 is a long-standing ticket that has a basic implementation. A better (perhaps?) approach with a working implementation is proposed below.
    88
    99'''NOTE THAT CSS COPYRIGHT ISSUES NEED TO BE SOLVED BEFORE THIS CAN BE MERGED.''' The CSS is Copyright (c) 2005 Lawrence Journal-World. Perhaps it can be shared at least with a Creative Commons Attribution-Noncommercial-No Derivative Works 3.0 United States License?
     
    1515Generating offline documentation should work as follows:
    1616 * there is a command '''builddocs''' that can be called from either `django-admin.py` or `manage.py`
    17   * that produces multiple-page HTML output from the docs by default, but accepts the option `--single` to produce single-page output
     17  * that produces multiple-page HTML output from the docs by default, but accepts the option `--single` to produce single-page output [DONE]
    1818  * PDF generation is less important, but should be implemented eventually, see http://code.google.com/p/rst2pdf (rather than pisa from http://www.htmltopdf.org/ as proposed in #528/#6443)
    1919 * the converter tries to make the documentation look similar to web docs by
    20    * using (a subset of) the Django official CSS http://media.djangoproject.com/css/homepage.css (discuss copyright issues)
    21    * using the customized docutils classes from source:djangoproject.com/django_website/apps/docs/builder.py
    22  * the inter-page links should be converted to make them work properly (by extending the docutils classes)
     20   * using (a subset of) the Django official CSS http://media.djangoproject.com/css/homepage.css (discuss copyright issues) [DONE]
     21   * using the customized docutils classes from source:djangoproject.com/django_website/apps/docs/builder.py [DONE]
     22 * the inter-page links should be converted to make them work properly (by extending the docutils classes) [DONE]
    2323 * less important: external images from http://media.djangoproject.com/img/doc/ can be retrieved and image links converted accordingly (`--with-images` option perhaps?)
    2424
    2525== Implementation ==
    2626
    27 The proposal has been mostly implemented, though neither inter-page links nor images have been dealt with.
     27The proposal has been implemented, inter-page links and table of contents work. Images have not been dealt with, I doubt if they are worth the trouble. CSS images are another thing though, but they are trivial to add, only copyright issues need to be sorted out.
    2828
    2929Usage:
Back to Top