cakephp/sphinxtheme

Name: sphinxtheme

Owner: CakePHP

Description: Sphinx theme and common configuration for CakePHP documentation projects.

Created: 2017-12-23 03:03:03.0

Updated: 2018-05-12 01:55:18.0

Pushed: 2018-02-05 02:18:16.0

Homepage: null

Size: 818

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

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.

one the docs
clone git@github.com:cakephp/docs cake_docs
ake_docs

eate a virtualenv
ualenv env

tivate the virtual env.
v/bin/activate

stall sphinx and other dependencies.
install -r requirements.txt

./

one this theme.
clone git@github.com/cakephp/sphinxtheme
phinxtheme

stall cakephpsphinx as an 'editable' package.
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