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.

The different themes are used on, but are not limited for this purpose. It might be used for all Plone Package Documentations, or even private use case but than without the Plone Logo and Footer (respect the License).


  • sphinxtheme.plone comes with own themes for

    • Plone Classic (Plone 2.0-3.3 Design)

    • Plone Sunburst (Plone 4 Design)

    • Plone Barceloneta (Plone 5 Design)

    • Plone Org 4 (Generation of Plone 4)

    • Plone Org 5 (Generation of Plone 5)



Install sphinxtheme.plone with buildout:



pip install

Install sphinxtheme.plone with pip:

pip install Sphinx sphinxtheme.plone

or add it to a requirements.txt and run

pip install -r requirements.txt


Edit the “” configuration file to point to the plone themes:

# At the top.
import sphinxtheme.plone

# ...

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

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

Additional switches for the theme, see detailed documentation. For the current, always set the following (this should be done in the of the related papyrus branch):

always_show_version_switcher = True always_show_language_switcher = True selected_version = the version of the docs that should come preselected in the dropdown, so 5, 4 or 3

Available Themes

  • plone_classic

  • plone_org_4

  • plone_org_5 (TODO: to be finalized)

  • plone_sunburst (TODO: to be finalized)

  • plone_barceloneta (TODO: to be implemented)



  • The technical parts of this project is licensed under the GPLv2 license.

  • The text and illustrations in this package / generated pages are licensed by the Plone Foundation under a Creative Commons Attribution 4.0 International license.

  • Plone and the Plone ® logo are registered trademarks of the Plone Foundation, registered in the United States and other countries.

  • For guidelines on the permitted uses of the Plone trademarks, see

  • All other trademarks are owned by their respective owners.

Download files

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

Source Distribution

sphinxtheme.plone-0.5.8.tar.gz (1.3 MB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page