LSST数据管理技术笔记Sphinx主题。
项目描述
从http://github.com/snide/sphinx_rtd_theme分支。
使用方法
在你的 requirements.txt 文件中添加
lsst-dd-rtd-theme
在你的 conf.py 文件中
import lsst_dd_rtd_theme
html_theme = "lsst_dd_rtd_theme"
html_theme_path = [lsst_dd_rtd_theme.get_html_theme_path()]变更日志
0.2.4 (2021-11-08)
使用最近的依赖集修复无序列表格式。
0.2.3 (2020-01-22)
使用 pyproject.toml 和 setup.cfg 文件现代化包装。我们现在还使用 setuptools_scm。在这个过程中，我们清理了早期版本中存在的许多包装元数据错误。
使用Travis CI发布到PyPI。
v0.1.8
开始记录变更日志：）
支持侧边栏中的第三和第四级标题
添加对Sphinx 1.3的支持
在Sphinx toctree中添加对:caption:的侧边栏标题支持
清理侧边栏滚动行为，使其永远不会滚动出视图
如何构建目录表
目前左侧菜单将根据您在index.rst文件中定义的任何toctree(s)构建。它输出2级深度，这应该能让您的访客高度访问您的文档。如果没有设置toctree，则主题将恢复到sphinx的常用本地toctree。
请注意，如果您在文档的rST标题中不遵循相同的样式，toctree将错误构建，生成的菜单在渲染时可能不会显示正确的深度。
另外，请注意，目录使用includehidden=true设置。这允许您在index文件中使用具有hidden属性的隐藏toc，从而允许您构建一个不渲染在索引中的目录。
默认情况下，导航将在您滚动时“粘”在屏幕上。但是，如果您的目录垂直过大，它将恢复到静态定位。要完全禁用粘性导航，请在conf.py中更改设置。
贡献或修改主题
lsst_dd_rtd_theme主要是一个sass项目，需要几个其他sass库。我使用bower来管理这些依赖关系，并使用sass来构建css。好消息是我有一套非常好的grunt操作，不仅可以加载这些依赖关系，还可以监视更改、重建sphinx演示文档并构建主题的可分发版本。坏消息是这意味着您需要设置类似于前端开发人员的环境（而不是Python开发人员）。这意味着需要安装node和ruby。
设置你的环境
将sphinx安装到虚拟环境中。
pip install sphinx安装sass
gem install sass安装node、bower和grunt。
// 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
grunt此默认任务将执行以下非常酷的事情，值得付出努力。
它将安装和更新任何bower依赖项。
它将运行sphinx并构建新文档。
它将监视sass文件的更改并从更改中构建css。
每当它注意到.rst、.html、.js或.css文件的更改时，它将重新构建sphinx文档。
下载文件
下载适合您平台的文件。如果您不确定选择哪个，请了解更多关于安装包的信息。