Skip to main content

A sphinx theme plugin support extension. #sphinxjp

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.

AUTHORS

Sphinx template plugin extension

  • Takayuki SHIMIZUKAWA <shimizukawa AT gmail.com> sphinx-users.jp

History

0.2.0 (2013/12/10)

  • A part of sphinxjp.themecore feature is merged into Sphinx-1.2(b3).

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

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.2.0.tar.gz (7.6 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for sphinxjp.themecore-0.2.0.tar.gz
Algorithm Hash digest
SHA256 55729fd3f70b0073da007829b54f533296a9787f03d68a45d747192fcae8c2ad
MD5 20c4d0ca1b4447fcda6f1b1638006caa
BLAKE2b-256 8040d37164eed91de8e496d52ddedf741343a45bfb4e2ec62d56f6dd89aaa3c5

See more details on using hashes here.

Provenance

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