agoraplex.themes.sphinx 0.1.3

要求

• Sphinx 1.1或更高版本

要重新构建来自SVG原始文件的图形（需要克隆github仓库）

• 来自librsvg的rsvg-convert

• pngtopam、pnmremap、pnmcolormap和pnmtopng来自Netpbm

• 来自icoutils的icotool

安装

要在您的Sphinx文档中使用主题，请遵循此指南

1. 安装包

   $ pip install agoraplex.themes.sphinx

2. 编辑您的conf.py文档配置文件，将其指向agoraplex主题

   import agoraplex.themes.sphinx
   
   # ...
   
   html_theme = 'agoraplex'
   html_theme_path = agoraplex.themes.sphinx.get_html_theme_path()

辅助工具

此软件包添加了几个Sphinx辅助角色（在roles.py中）。要使用这些角色，请将agoraplex.themes.sphinx.roles添加到您的conf.py中的extensions列表。

这些角色包括

• github：链接到github项目

  :github:`agoraplex/themes`

  配置指令 github_url 的默认值是 https://github.com/。

• pypi：指向 PyPi（Python 包索引）上的项目记录的链接 PyPi

  :pypi:`agoraplex.themes.sphinx`

  配置指令 pypi_url 的默认值是 http://pypi.python.org/pypi/

• wikipedia：指向一个 Wikipedia 文章的链接

  :wikipedia:`Ancient Agora of Athens`

  配置指令 wikipedia_url 和 wikipedia_lang 的默认值分别为 http://%s.wikipedia.org/wiki/ 和 en。注意，wikipedia_url 指令 必须 包含一个 %s，其中角色将插入 wikipedia_lang 的值。

  wikipedia 角色将（主要）通过用下划线（_）替换空格、将名称的首字母大写和其余字母小写来规范化文章名称。Wikipedia 自己的 URL 重新编写对大小写不匹配有容忍度，因此这些简单的规则足够有效。

配置

除了与角色相关的配置指令外，此主题还向原始 Pylons 主题定义的集合中添加以下指令

• fontsets：一个由空格分隔的目录名称列表，相对于 字体目录（_static/fonts），从中加载包含 @font-face 指令的 stylesheet.css 文件。

• font_body，font_header：用于正文和标题文本的字体“基本”名称。