Changes between Version 4 and Version 5 of DjangoSpecifications/Docs/ConvertingRestToOtherFormats

Timestamp:

Mar 20, 2008, 4:44:35 PM (17 years ago)

Author:

mrts

Comment:

--

DjangoSpecifications/Docs/ConvertingRestToOtherFormats

@@ -22 +22 @@
 
 The proposal has been mostly implemented, though neither inter-page links nor images have been dealt with.
+
+Usage:
+{{{
+$ trunk/django/bin/django-admin.py help htmldocs
+Usage: django-admin.py htmldocs [options] [Django documentation directory] [output directory]
+
+Converts Django documentation to HTML. Uses the given Django documentation directory for reading documentation source and output directory for writing HTML files. Creates the output directory if it does not exist.
+
+Options:
+  --settings=SETTINGS   The Python path to a settings module, e.g.
+                        "myproject.settings.main". If this isn't provided, the
+                        DJANGO_SETTINGS_MODULE environment variable will be
+                        used.
+  --pythonpath=PYTHONPATH
+                        A directory to add to the Python path, e.g.
+                        "/home/djangoprojects/myproject".
+  --traceback           Print traceback on exception
+  --single              Write a single combined HTML file. Not recommended,
+                        produces output that is harder to navigate.
+  --version             show program's version number and exit
+  -h, --help            show this help message and exit
+}}}
 
 This is an example run: