pylons-sphinx-themes 1.0.10

编辑项目的setup.py

1. 将pylons-sphinx-themes添加到项目的setup.py需求中。 这是金字塔的一个例子

   docs_extras=['Sphinx >= 1.7.5',# Read The Docs minimum version'docutils','repoze.sphinx.autointerface','pylons-sphinx-themes',]

编辑斯芬克斯的conf.py

1. 在顶部，添加以下内容。

   importpylons_sphinx_themes

2. 激活主题。

   html_theme='pyramid'html_theme_path=pylons_sphinx_themes.get_html_themes_path()

3. （建议）启用Ethical Ads。 这样做同时支持Read the Docs和Python Software Foundation广告收入。

   # Control display of sidebarshtml_sidebars={'**':['localtoc.html','ethicalads.html','relations.html','sourcelink.html','searchbox.html',]}

4. 如果您以前使用git子模块方法来使用pylons主题，那么在下面的语句下注释或删除代码块。

   # Add and use Pylons themeif'sphinx-build'in' '.join(sys.argv):# protect against dumb importers

5. （可选）设置规范的根URL。 URL指向文档的根，并需要一个尾随斜杠

   html_theme_options=dict(canonical_url='http://the_root_domain/latest/docs/')

撤消git子模块方法

如果以前使用git子模块方法来使用pylons主题，那么执行以下附加步骤。

1. 删除.gitmodules。

   cd <your_project_directory>
   git rm .gitmodules
   

2. 取消对子模块的初始化。

   cd docs/_themes
   git submodule deinit .
   

3. 删除子模块的目录

   cd ..
   git rm _themes/
   

4. 编辑狮身人面像的Makefile。下面是来自金字塔的example diff

   -html: themes
   +html:
   # ...
   -htmlhelp: themes
   +htmlhelp:
   #...
   -themes:
   -    cd ..; git submodule update --init --recursive; cd docs;

更新tox.ini

如果使用tox，则可以在setup.py（首选）或tox.ini（重复）中指定生成文档的依赖项请参阅example from Pyramid

docs_extras=[
    'Sphinx >= 1.7.5',
    'docutils',
    'repoze.sphinx.autointerface',
    'pylons_sphinx_latesturl',
    'pylons-sphinx-themes',]# ...extras_require={
    'testing':testing_extras,
    'docs':docs_extras,},

否则，您可以重复您自己并编辑您的tox.ini以下示例来自waitress。

deps=
    Sphinx
    repoze.sphinx.autointerface
    pylons-sphinx-themes

更新读取文档配置

如果指定读取文档的包要求，请在rtd.txt中指定依赖项您可以显式地命名它们，这可能是重复的：

pylons-sphinx-themes

或者您可以依赖于您的setup.py配置，只在一个地方指定依赖项，只需在您的rtd.txt中使用它。

-e .[docs]

可用主题

• pylons-通用pylons项目文档主题
• 金字塔-特定的金字塔文档主题
• pylonsfw-特定的Pylons框架文档主题

1.0.10（2018-09-25）

• 将已读文档添加到广告收入接收者

1.0.9（2018-09-23）

• 删除连字符，因为它有时连字符不正确，例如 在密码里。

1.0.8（2018-09-21）

• 修复对道德广告的支持。

1.0.7（2018-09-21）

• 增加了对阅读文档的道德广告的支持见 https://github.com/Pylons/pylons-sphinx-themes/pull/12

1.0.6（2017-09-22）

• 更新zest.releaser以便发布到pypi。

1.0.5（2017-09-22）

• 清理许可证 https://github.com/Pylons/pylons-sphinx-themes/issues/8

1.0.4（2017-06-20）

• 仅在.body类中为列表项指定行距

1.0.3（2017-06-20）

• 为列表项添加行距。关闭#4

1.0.2（2017-06-16）

• 删除HTTPS协议以允许HTTPS或HTTP

1.0.1（2017-06-16）

• 样式表的协议使用https。

1.0（2017-04-18）

• 使用Zest.Releaser释放。
• 改善文档。

0.3.1（2015-04-15）

• 改进文档

0.3（2015-04-15）

• 使用中使用的git子模块转换 https://github.com/Pylons/pylons_sphinx_theme到一个包。见 https://github.com/Pylons/pyramid/issues/1614
• 初始提交