Numerical experiments, Tips, Tricks and Gotchas
Sphinx [1], [2] is a documentation generator which converts reStructuredText [3], [4] files into HTML websites and other formats including PDF, EPub and man.
Excellent tutorials by Brandon Rhodes: readthedocs [5], PyCon 2013 video [6], PDF [7], GitHub [8]. Numerous other tutorials are also available on the Internet [9], [10], [11], [12] [13], [14], [15]. Alfredo Deza's tutorial [10] has a sample Sphinx project.
The default theme is really ugly. However, Sphinx supports changing the appearance of its HTML output via themes [16], [17]. A nice collection of themes comes with installation. In the default Anaconda installation they are in
Win:
C:\Anaconda3\Lib\site-packages\sphinx\themesMac:
~/anaconda/lib/python3.4/site-packages/sphinx/themes/or under the virtual environments directory
Win:
C:\Anaconda3\Lib\site-packages\conda_envMac:
~/anaconda/envs/py27/lib/python2.7/site-packages/sphinx/themes/The following themes are in my installation [16]:
agogo basic bizstyle default epub haiku nature pyramid scrolls sphinxdoc traditionalMany more themes are on the Internet.
Here [18] is a nice collection of
© Nikolai Shokhirev, 2012-2024
email: nikolai(dot)shokhirev(at)gmail(dot)com