Usage

This guide describes how to use Plone Sphinx Theme for documentation of your project. By following this guide, you can consistently reproduce results in any environment, including to Read the Docs.

See also

To contribute code to Plone Sphinx Theme, first follow the Contributing policies, then Contribute to Plone Sphinx Theme. To develop your own theme based upon Plone Sphinx Theme, see Develop your own theme.

Prerequisites

• Python 3.10, 3.11, 3.12, or 3.13.

• Create a Python virtual environment for your project, and optionally activate it. The following commands assume you have activated your virtual environment.

Configuration

1. Add Plone Sphinx Theme to your project's documentation requirements.

   pyproject.toml

   [project.optional-dependencies]
   
   docs = [
     "plone-sphinx-theme",
   ]
   

   requirements-docs.txt

   plone-sphinx-theme
   

2. Install Plone Sphinx Theme according to Step 3.

   pyproject.toml

   pip install my_project[docs]
   

   requirements-docs.txt

   pip install -r requirements-docs.txt
   

3. Configure your conf.py.

   html_theme = "plone_sphinx_theme"
   

Now you can build your documentation using this theme.