Contents¶

Features¶

• Easy ability to install/use as a Python package (tip o’ the hat to Dave & Eric’s sphinx_rtd_theme for showing the way);
• CakePHP-based documentation theme

Project background¶

The CakePHP documentation theme is a theme made for use with CakePHP projects. This allows developers to distribute their own documentation in a format that adheres to the CakePHP documentation styleguide.

When Should I use this Theme?¶

This theme should be used when:

• You are developing a CakePHP-related plugin or project
• You are attempting to promote CakePHP

You should not use this project for:

• Projects not related to CakePHP, e.g. projects for other frameworks or for strictly-php libraries
• You are misrepresenting the CakePHP, e.g. stating that your project is an official project when it is not.

Please note that the above list is not exhaustive, and is subject to change.

Requirements¶

• Python and Pip
• Sphinx 1.5+

Setup¶

• You will need to install the cakephp_theme package:

# from pypi
pip install cakephp_theme

# from github
pip install -e git+https://github.com/cakephp/doc-theme/#egg=cakephp_theme

Usage¶

Add the following to your conf.py so the theme location is loaded:

import cakephp_theme

html_theme_path = [cakephp_theme.get_path()]
html_theme = 'cakephp_theme'
extensions = ['cakephp_theme']

Add an explicit html_context setting so the theme’s customized attributes are properly initialized:

html_context = {
    'maintainer': 'Your Name',
    'project_pretty_name': 'Your Project Name',
    'projects': {
        'CakePHP Book': 'https://book.cakephp.org/',
        'Some other project': 'https://example.com/',
    }
}

That’s it! You now have the CakePHP documentation theme set up.