Skip to main content

A sphinx theme plugin extension.

Project description

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.

History

0.1.0 (2011/2/6)

  • first release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxjp.themecore, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinxjp.themecore-0.1.0.tar.gz (6.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page