lsst-dd-rtd-theme 0.2.1

内容

• Using it
• Changelog
• How the Table of Contents builds
• Contributing or modifying the theme
  • Set up your environment

Using it

在您的requirements.txt中添加：

-e git://github.com/lsst-sqre/lsst_dd_rtd_theme.git@master#egg=lsst_dd_rtd_theme

在conf.py文件中：

importlsst_dd_rtd_themehtml_theme="lsst_dd_rtd_theme"html_theme_path=[lsst_dd_rtd_theme.get_html_theme_path()]

Changelog

v0.1.8

• 开始保存更改日志：）
• 支持侧边栏中的三级和四级标题
• 添加对Sphinx 1.3的支持
• 在sphinx目录树中为：caption:添加侧边栏标题
• 清除侧边栏滚动行为，使其永远不会滚动出视图

How the Table of Contents builds

当前，左菜单将基于index.rst文件中定义的任何toctree(s)生成。 它输出两个深度级别，这将使您的访问者能够更高级别地访问您的 博士学位。如果没有设置toctree，则主题将恢复为sphinx通常的本地toctree。

重要的是要注意，如果你不遵循相同的样式为你的第一个标题 您的文档，目录树将被错误构建，结果菜单可能不会显示正确的 渲染时的深度。

还要注意，目录是用includehidden=true设置的。这让你 使用hidden属性在索引文件中设置隐藏的目录 在索引中不呈现的情况下生成目录。

默认情况下，滚动时导航将“粘住”屏幕。但是如果你的TOC 垂直方向太大，将还原为静态定位。禁用粘性导航 完全更改conf.py中的设置。

Contributing or modifying the theme

lsst-dd-rtd主题主要是一个sass项目，它需要一些其他sass库。我是 使用bower来管理这些依赖项，并使用sass来构建css。好消息是 我有一组非常好的grunt操作，它们不仅可以加载这些依赖项，还可以监视 对于更改，重建sphinx演示文档并构建主题的可分发版本。 坏消息是，这意味着您需要设置类似的环境 前端开发人员（与python开发人员相比）。这意味着要安装node和ruby。

pip install sphinx

gem install sass

// Install node
brew install node

// Install bower and grunt
npm install -g bower grunt-cli

// Now that everything is installed, let's install the theme dependecies.
npm install

grunt