mirror of
https://github.com/django/django.git
synced 2025-06-05 11:39:13 +00:00
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:
parent
57f49453c7
commit
4eec036ab3
2
README
2
README
@ -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
|
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.
|
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
|
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
|
should be clarified in any way, please take 30 seconds to fill out a ticket
|
||||||
here:
|
here:
|
||||||
|
17
docs/README
Normal file
17
docs/README
Normal 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/
|
Loading…
x
Reference in New Issue
Block a user