Documentation

This is release 2.0.5 of a Python package named PSphinxTheme. P-Sphinx Theme stands for Projects-Sphinx Theme.

It contains a main Sphinx theme named “p-main_theme” and some derivation of it, as well as some related Sphinx extensions. P-Sphinx Theme and its extensions are primarily oriented towards generating html documentation for Python libraries using Python 3. It provides numerous small enhancements to make the html documentation more interactive, improve the layout on mobile devices, and others.

Acknowledgements

Most parts of P-Sphinx Theme's code and documentation originate from Eli Collins’s excellent cloud_sptheme v1.6.

THANKS

Main changes

To fit my own projects.

• renamed
• reformatted (3 space indentation, 125 char lines)
• some fixes
• removed python2 related parts
• changes and additions

SeeAlso

Changelog

Contents

Themes

p-main_theme: P-Sphinx Main Theme the main Sphinx theme provided by this package.

p-green: a derivation of the p-main_theme theme

p-greenblue: a derivation of the p-main_theme theme

p-greycreme: a derivation of the p-main_theme theme

p-red: a derivation of the p-main_theme theme used for this documentation

Extensions

The following Sphinx extensions provide features used by the P-SphinxTheme:

PSphinxTheme.ext.index_styling

Adds additional css styling classes to the index page.

PSphinxTheme.ext.relbar_links

Adds any link to the top/bottom navigation bar.

PSphinxTheme.ext.psphinx_admonitions

A collection of all official P-SphinxTheme admonitions

PSphinxTheme.ext.sidebarlogo_perpag

PSphinxTheme.ext.sidebarlogo_perpag - override sphinx sidebar logo per-page

This package also provides a few extra Sphinx extensions which may be useful when documenting Python projects:

PSphinxTheme.ext.issue_tracker

Adds a special :issue: role for quickly linking to your project’s issue tracker.

PSphinxTheme.ext.escaped_samp_literals

Patches Sphinx to permit escaped {} characters within a :samp: role.

PSphinxTheme.ext.table_styling

Enhances .. table directive to support per-column text alignment and other layout features.

Reference

Installation Instructions

requirements and installations instructions

Release History

history of current and past releases

Examples

“P-Sphinx Theme” Feature Test

main display of various features of the P-Sphinx Theme

Online Resources

Homepage:	https://github.com/peter1000/PSphinxTheme
Online Docs:	http://packages.python.org/PSphinxTheme
Download & PyPI:	http://pypi.python.org/pypi/PSphinxTheme

Related Resources

System Message: ERROR/3 (/home/workerm/Downloads/PSphinxTheme/docs/index.rst, line 128)

Malformed table. Text in column margin in table line 2.

=================== ==================================================== ================================================
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

  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).