CakePHP Sphinx Theme

This is the sphinx theme used for the official CakePHP documentation projects. It helps create HTML, PDF, and EPUB formats consistently across all the CakePHP projects and branches.

You can see this theme in action at https://book.cakephp.org

For the actual CakePHP documentation see cakephp/docs.

Developing/Testing changes to this theme

Working with this theme requires you to have sphinx installed in a virtualenv. Lets assume you want to test some theme changes out with cakephp/docs.

# Clone the docs
git clone git@github.com:cakephp/docs cake_docs
cd cake_docs

# Create a virtualenv
virtualenv env

# Activate the virtual env.
. env/bin/activate

# Install sphinx and other dependencies.
pip install -r requirements.txt

cd ../

# Clone this theme.
git clone git@github.com/cakephp/sphinxtheme
cd sphinxtheme

# Install cakephpsphinx as an 'editable' package.
pip install -e .

You should now be able to preview changes to your docs theme by rebuilding the documentation.

Publishing Releases

1. Update __version__ in setup.py
2. Commit changes to setup.py
3. Create a new tag
4. Publish a wheel python setup.py bdist_wheel upload

License

MIT License