https://github.com/plone/sphinxtheme.plone
Sphinx Themes for Plone Documentation Project
https://github.com/plone/sphinxtheme.plone
documentation plone sphinx
Last synced: about 2 months ago
JSON representation
Sphinx Themes for Plone Documentation Project
- Host: GitHub
- URL: https://github.com/plone/sphinxtheme.plone
- Owner: plone
- License: gpl-2.0
- Created: 2014-04-23T13:11:09.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2024-03-18T02:44:04.000Z (over 1 year ago)
- Last Synced: 2025-05-28T10:48:50.723Z (4 months ago)
- Topics: documentation, plone, sphinx
- Language: CSS
- Homepage:
- Size: 1.51 MB
- Stars: 2
- Watchers: 164
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: LICENSE
Awesome Lists containing this project
README
======================================
Sphinx Themes for Plone Documentation
======================================
sphinx.themes.plone is a collection of `Sphinx `_ themes for the `Plone `_ documentation project.
The different themes are used on `docs.plone.org `_, 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).
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
--------
Install sphinxtheme.plone with buildout::
[buildout]
parts=
sphinx
[sphinx]
recipe=zc.recipe.egg
eggs=
Sphinx
sphinxtheme.plone
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
.. CAUTION::
*You should never use a checkout of the theme package for applying a theme to your documentations.*
Never touch this package to adjust configuration or customize parts, there is no need for that.
Read the documentation please: http://docs.plone.org/...
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
.. _licence:
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 :sup:`®` 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.