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.

Source Distribution

sphinxjp.themecore-0.1.0.tar.gz (6.1 kB view details)

Uploaded Source

File details

Details for the file sphinxjp.themecore-0.1.0.tar.gz.

File metadata

File hashes

Hashes for sphinxjp.themecore-0.1.0.tar.gz
Algorithm Hash digest
SHA256 06e3fe0e45d3b9612813f9fb6d6ffe2b8eb6adf4f889d41ed04e3e9304e89750
MD5 0658d82885149311290a0f46e5abe1b5
BLAKE2b-256 a3b19a66b48325509d94ef3707fd3290a83cf9db0291f3c5eb4cdf610b8aee5f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page