Features

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

Installation

[buildout]
parts=
    sphinx

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

Configuration

Edit the “conf.py” 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 docs.plone.org, always set the following (this should be done in the conf.py 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)

Contribute

• Issue Tracker: https://github.com/plone/sphinx.themes.plone/issues

• Source Code: https://github.com/plone/sphinx.themes.plone

License

• 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 https://plone.org/foundation/logo

• All other trademarks are owned by their respective owners.