Skip to content
Newer
Older
100644 18 lines (11 sloc) 632 Bytes
4eec036 @spookylukey Added a README for building offline HTML docs.
spookylukey authored Nov 6, 2010
1 The documentation in this tree is in plain text files and can be viewed using
2 any text file viewer.
3
8198a19 @shabda Fixed #18928. Tightened language in docs/README.
shabda authored Sep 8, 2012
4 It uses ReST (reStructuredText) [1], and the Sphinx documentation system [2].
5 This allows it to be built into other forms for easier viewing and browsing.
4eec036 @spookylukey Added a README for building offline HTML docs.
spookylukey authored Nov 6, 2010
6
c0e73a4 @aaugustin Fixed #9995 -- Updated the installation instructions to recommend pip…
aaugustin authored Mar 3, 2012
7 To create an HTML version of the docs:
4eec036 @spookylukey Added a README for building offline HTML docs.
spookylukey authored Nov 6, 2010
8
c0e73a4 @aaugustin Fixed #9995 -- Updated the installation instructions to recommend pip…
aaugustin authored Mar 3, 2012
9 * Install Sphinx (using ``sudo pip install Sphinx`` or some other method)
4eec036 @spookylukey Added a README for building offline HTML docs.
spookylukey authored Nov 6, 2010
10
8f7b502 @jezdez Fixed #16414 -- Added standard Windows make batch file for Sphinx. Th…
jezdez authored Jul 19, 2011
11 * In this docs/ directory, type ``make html`` (or ``make.bat html`` on
12 Windows) at a shell prompt.
4eec036 @spookylukey Added a README for building offline HTML docs.
spookylukey authored Nov 6, 2010
13
14 The documentation in _build/html/index.html can then be viewed in a web browser.
15
16 [1] http://docutils.sourceforge.net/rst.html
17 [2] http://sphinx.pocoo.org/
Something went wrong with that request. Please try again.