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

Timestamp:

Mar 20, 2008, 7:16:47 PM (17 years ago)

Author:

mrts

Comment:

New patch that fixes links implemented

DjangoSpecifications/Docs/ConvertingRestToOtherFormats

@@ -5 +5 @@
 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.
+#528 is a long-standing ticket that has a basic implementation. A better (perhaps?) approach with a working implementation is proposed below.
 
 '''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?
@@ -15 +15 @@
 Generating offline documentation should work as follows:
  * there is a command '''builddocs''' that can be called from either `django-admin.py` or `manage.py`
-  * that produces multiple-page HTML output from the docs by default, but accepts the option `--single` to produce single-page output
+  * that produces multiple-page HTML output from the docs by default, but accepts the option `--single` to produce single-page output [DONE]
   * 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)
  * the converter tries to make the documentation look similar to web docs by
-   * using (a subset of) the Django official CSS http://media.djangoproject.com/css/homepage.css (discuss copyright issues)
-   * using the customized docutils classes from source:djangoproject.com/django_website/apps/docs/builder.py
- * the inter-page links should be converted to make them work properly (by extending the docutils classes)
+   * using (a subset of) the Django official CSS http://media.djangoproject.com/css/homepage.css (discuss copyright issues) [DONE]
+   * using the customized docutils classes from source:djangoproject.com/django_website/apps/docs/builder.py [DONE]
+ * the inter-page links should be converted to make them work properly (by extending the docutils classes) [DONE]
  * less important: external images from http://media.djangoproject.com/img/doc/ can be retrieved and image links converted accordingly (`--with-images` option perhaps?)
 
 == Implementation ==
 
-The proposal has been mostly implemented, though neither inter-page links nor images have been dealt with.
+The 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.
 
 Usage: