How to install sphinxjp.themecore
- Download and install ActivePython
- Open Command Prompt
- Type
pypm install sphinxjp.themecore
Depended by
- sphinx.plonetheme
- sphinxjp.themes.basicstrap
- sphinxjp.themes.biz_blue_simple
- sphinxjp.themes.bizstyle
- sphinxjp.themes.dotted
- sphinxjp.themes.htmlslide
- sphinxjp.themes.impressjs
- sphinxjp.themes.revealjs
- sphinxjp.themes.s6
- sphinxjp.themes.solarized
- sphinxjp.themes.sphinxjp
- sphinxjp.themes.tinkeralizarin
- sphinxjp.themes.tinkerbelizehole
- sphinxjp.themes.tinkerpress
- sphinxjp.themes.tinkerturquoise
- sphinxjp.themes.trstyle
Lastest release
A sphinx theme plugin extension.
Features
- provide theme template collection by using setuptools plugin mechanism.
Setup
Make environment with easy_install:
$ easy_install sphinxjp.themecore
Make your plugins
themes
If you want to integrate new theme, write sphinx_themes entry_points in your setup.py:
entry_points = """ [sphinx_themes] path = sphinxjp.themes.s6:get_path """
and write get_path function that return path of Sphinx themes. Sphinx themes directory include one or more theme directories.
directives
If you want to integrate new directive, write sphinx_directives entry_points in your setup.py:
entry_points = """ [sphinx_directives] setup = sphinxjp.themes.s6:setup_directives """
and write setup_directives function that receive app argument and return None. setup_directives is same as sphinx extension's setup function. See Sphinx extension document for more information.
Requirements
- Python 2.4 or later (not support 3.x)
- sphinx 1.0.x
License
Licensed under the MIT license . See the LICENSE file for specific terms.
AUTHORS
Sphinx template plugin extension
- Takayuki SHIMIZUKAWA <shimizukawa AT gmail.com> sphinx-users.jp
History
0.1.3 (2011/7/9)
- fix fatal bug on version 0.1.2. sorry.
0.1.2 (2011/7/9)
- fixed issue #1: html_theme_path definition in conf.py discard all sphinxjp.themes.* paths.
0.1.1 (2011/7/6)
- fixed namespace package declaration missing, thank you togakushi!
0.1.0 (2011/2/6)
- first release