=============
P-SphinxTheme
=============

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 <https://bitbucket.org/ecollins/cloud_sptheme>`_ by **Eli Collins**

- `Sphinx <http://sphinx-doc.org/>`_  for version see {SOURCE}/requirements.txt
- `python_lconf_lexer <https://github.com/LCONF/python_lconf_lexer>`_


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 <http://sphinx-doc.org/>`_
#. If not already installed - install `python_lconf_lexer <https://github.com/LCONF/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
================
- Docs:       http://packages.python.org/PSphinxTheme
- PyPI:       http://pypi.python.org/pypi/PSphinxTheme
- Source:     https://github.com/peter1000/PSphinxTheme

Related Resources
-----------------
- python_lconf_lexer: `<https://github.com/LCONF/python_lconf_lexer>`_ a simple pygments lexer for LCONF


Projects using PSphinxTheme
===========================

Known `projects` which make use of: **PSphinxTheme**

- `PySpeedIT <https://github.com/peter1000/PySpeedIT>`_
   A collection of: Benchmark-IT, Profile-IT, Line-Memory-Profile-IT, Disassemble-IT.

- `LCONF <https://github.com/peter1000/LCONF>`_
   L(ight) CONF(iguration): A light - human-friendly, simple readable data serialization format for dynamic configuration.

- `JqPyCharts <https://github.com/peter1000/JqPyCharts>`_
   `JqPyCharts` is a selection of: Javascripts / Css for simple charts in python projects.

- `PyNHEP <https://github.com/peter1000/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 <http://opensource.org/licenses/BSD-3-Clause>`_.

(c) 2014, `peter1000` https://github.com/peter1000
All rights reserved.

|
|
