Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
sphinx [2015/07/12 04:08] slackermedia created |
sphinx [2015/07/12 18:37] slackermedia |
||
|---|---|---|---|
| Line 42: | Line 42: | ||
| ===== Install ===== | ===== Install ===== | ||
| - | Install Sphinx from [[http://slackbuilds.org]], but mind that the "S" is a //capital// "S". There is a search engine called "sphinx" (with a small "s"); you are looking for the Python text processor, not the search engine. | + | Install Sphinx from [[http://slackbuilds.org]], but mind that the "S" is a //capital// "S". There is a search engine called "sphinx" (with a small "s"); you are looking for the Python text processor, not a search engine. |
| Sphinx depends upon several other Python libraries, so install those first. | Sphinx depends upon several other Python libraries, so install those first. | ||
| Line 69: | Line 69: | ||
| Do you want to use the epub builder (y/n) [n]: y | Do you want to use the epub builder (y/n) [n]: y | ||
| </code> | </code> | ||
| + | |||
| + | <WRAP tip> | ||
| + | Above all else, answer **Yes** for a ''Makefile''. You can refuse the Windows batch file , but accept the Unix ''Makefile''; without it, the build process is slightly less convenient. | ||
| + | </WRAP> | ||
| In the end, you are left with a directory containing a ''Makefile'', a ''build'' and a ''source'' directory. In the ''source'' directory are two essential Sphinx files: | In the end, you are left with a directory containing a ''Makefile'', a ''build'' and a ''source'' directory. In the ''source'' directory are two essential Sphinx files: | ||
| Line 114: | Line 118: | ||
| </code> | </code> | ||
| - | [{{ sphinx.jpg | The most basic Sphinx project possible. }}] | + | [{{ sphinx.jpg?666 | The most basic Sphinx project possible. }}] |
| ==== Advanced Techniques ==== | ==== Advanced Techniques ==== | ||
| Line 144: | Line 148: | ||
| ================ | ================ | ||
| - | It was a **dark** and stormy night. | + | It was a **dark** and *stormy* night. |
| Sub-Heading | Sub-Heading | ||
| Line 155: | Line 159: | ||
| <code> | <code> | ||
| + | **bold** text | ||
| + | *italics* text | ||
| + | ``monospace`` text | ||
| </code> | </code> | ||
| + | The official Sphinx overview of ReST markdown is located on their site at [[http://sphinx-doc.org/rest.html]], but a better re-interpretation of that is located at [[http://openalea.gforge.inria.fr/doc/openalea/doc/_build/html/source/sphinx/rest_syntax.html]] | ||