innov
/
django1
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity

Added a README for building offline HTML docs. 

git-svn-id: http://code.djangoproject.com/svn/django/trunk@14478 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Luke Plant 2010-11-06 17:44:26 +00:00
parent 57f49453c7
commit 4eec036ab3
2 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README
View File

@ -17,6 +17,8 @@ how we recommend you read the docs:
next; from there you can jump to the HOWTOs (in docs/howto) for specific
problems, and check out the reference (docs/ref) for gory details.
* See docs/README for instructions on building an HTML version of the docs.
Docs are updated rigorously. If you find any problems in the docs, or think they
should be clarified in any way, please take 30 seconds to fill out a ticket
here:

17
docs/README Normal file
View File

@ -0,0 +1,17 @@
The documentation in this tree is in plain text files and can be viewed using
any text file viewer.
Technically speaking, it uses ReST (reStructuredText) [1], and the Sphinx
documentation system [2]. This allows it to be built into other forms for
easier viewing and browsing.
To create an HTML version of the docs on a Unix machine (Linux or Mac):
* Install Sphinx (using ``easy_install Sphinx`` or some other method)
* In this docs/ directory, type ``make html`` at a shell prompt.
The documentation in _build/html/index.html can then be viewed in a web browser.
[1] http://docutils.sourceforge.net/rst.html
[2] http://sphinx.pocoo.org/