Skip to main content

Collection of Sphinx Themes for Plone Documentations

Project description

sphinx.themes.plone is a collection of Sphinx themes for the Plone documentation project.

Features

  • sphinx.themes.plone comes with own themes for Plone 3, Plone4 and Plone 5

Installation

Install sphinx.themes.plone with pip:

pip install sphinx.themes.plone

Install sphinx.themes.plone with buildout:

[buildout]
parts=
    sphinx

[sphinx]
recipe=zc.recipe.egg
eggs=
    Sphinx
    sphinx.themes.plone

Configuration

Edit the “conf.py” configuration file to point to the plone themes:

# At the top.
import sphinx.themes.plone

# ...

# Activate the theme path:
html_theme_path = sphinx.themes.plone.get_html_theme_path()

# Activate the theme like this:
html_theme = 'plone_org_4'

Available Themes

  • plone_classic (TODO: to be implemented)

  • plone_sunburst (TODO: to be implemented)

  • plone_org_4

  • plone_org_5 (TODO: to be finalized)

Contribute

License

The project is licensed under the GPLv2 license.

Changelog

0.1.1 (26/06/2014)

  • Add option for Google Analytics configuration [svx]

  • Added MANIFEST.in to include docs folder [loechel]

  • fixes install error [loechel]

0.1.0 (01/06/2014)

  • Initial release

  • Theme plone_org_4

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx.themes.plone-0.1.1.tar.gz (952.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page