跳转到主要内容

支持扩展的 Sphinx 主题插件。 #sphinxjp

项目描述

Sphinx 主题插件扩展。

功能

  • 通过使用 setuptools 插件机制提供主题模板集合。

设置

使用 easy_install 创建环境

$ easy_install sphinxjp.themecore

创建您的插件

主题

如果您想集成新主题,请在 setup.py 中编写 sphinx_themes entry_points

entry_points = """
    [sphinx_themes]
    path = sphinxjp.themes.s6:get_path
"""

并编写一个返回 Sphinx 主题 路径的 get_path 函数。 Sphinx 主题 目录包含一个或多个主题目录。

指令

如果您想集成新的指令,请在您的 setup.py 中编写 sphinx_directives entry_points

entry_points = """
    [sphinx_directives]
    setup = sphinxjp.themes.s6:setup_directives
"""

并编写一个接受 app 参数并返回 None 的 setup_directives 函数。 setup_directives 与 Sphinx 扩展的 setup 函数相同。有关更多信息,请参阅 Sphinx 扩展文档。

需求

  • Python 2.4 或更高版本(不支持 3.x)

  • sphinx 1.0.x

许可证

许可协议为 MIT 许可协议 。有关具体条款,请参阅 LICENSE 文件。

作者

Sphinx 模板插件扩展

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

历史

0.2.0 (2013/12/10)

  • Sphinxjp.themecore 功能的一部分已合并到 Sphinx-1.2(b3)。

0.1.3 (2011/7/9)

  • 修复了版本 0.1.2 上的致命错误。抱歉。

0.1.2 (2011/7/9)

  • 修复了问题 #1:在 conf.py 中定义 html_theme_path 会丢弃所有 sphinxjp.themes.* 路径。

0.1.1 (2011/7/6)

  • 修复了命名空间包声明缺失的问题,感谢 togakushi!

0.1.0 (2011/2/6)

  • 首次发布

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解更多关于 安装软件包 的信息。

源代码分发

sphinxjp.themecore-0.2.0.tar.gz (7.6 kB 查看散列)

上传时间 源代码

支持