A sphinx theme I use for most projects. Derivative of Eli Collins's cloud_sptheme.
Project description
About
A sphinx theme I use for most projects. Derivative of “Eli Collins’s cloud_sptheme”.
The latest documentation can be found online at http://packages.python.org/PSphinxTheme.
Requirements
Python 3
for python2 look at the original cloud_sptheme by Eli Collins
Sphinx for version see {SOURCE}/requirements.txt
Installation
To install from pypi using pip/pip3:
$ pip3 install PSphinxTheme
To install from the source:
$ python3 setup.py install
Building the Documentation
If you wish to generate your own copy of the documentation, you will need to:
Get the PSphinxTheme source.
If not already installed - install Sphinx
If not already installed - install python_lconf_lexer
From the PSphinxTheme source directory, run python3 setup.py build_sphinx -E.
Once Sphinx is finished, point a web browser to the file:
{SOURCE}/build/sphinx/html/index.html
Online Resources
Projects using PSphinxTheme
Known projects which make use of: PSphinxTheme
- PySpeedIT
A collection of: Benchmark-IT, Profile-IT, Line-Memory-Profile-IT, Disassemble-IT.
- LCONF
L(ight) CONF(iguration): A light - human-friendly, simple readable data serialization format for dynamic configuration.
- JqPyCharts
JqPyCharts is a selection of: Javascripts / Css for simple charts in python projects.
- PyNHEP
PyNHEP: The N(utrition) and H(ealthy) E(ating) P(lanner).
PSphinxTheme is distributed under the terms of the BSD 3-clause license.
Consult LICENSE or BSD-3-Clause.
(c) 2014, peter1000 https://github.com/peter1000 All rights reserved.
