斯芬克斯主题文献网站
sphinx-docs-theme的Python项目详细描述
斯芬克斯的一个基于最简引导的HTML5主题。用于生成 文档站点。
检查latest docs以了解如何设置它。
皮肤是从静态模板Docs Bootstrap Template改编而来的， 它是项目要遵循的视觉参考。
功能
- 极简和反应式外观
- HTML5
- Bootstrap 3
- Font Awesome图标
- highlight.js用于语法突出显示
- 为Facebook’s Open Graph和Twitter Cards准备
演示
要在工作中检查sphinx文档主题，请查看链接到 下面这个部分，是用狮身人面像创建的，并利用了这个主题。
文件
文档源包含在项目中，用于生成 文档站点：
- 始终为最新版本生成latest docs，保存在“master”分支中
- development docs是从“development”分支中的最新代码生成的
文档的源文件是一个小型的Sphinx项目，保存在“docs”文件夹中。
如果需要，这些可以构建：
$ python setup.py build_docs
用法
该项目是一个Sphinx主题，可以类似于任何 其他这样的主题。
先决条件
Sphinx需要使用这个主题，因为它是要集成的 变成狮身人面像。要查找有关此的详细信息，请查看其网页， 它还将告诉您可以使用哪些python解释器。
所有其他python依赖项都显示在requirements.txt文件中。
这些依赖项可以通过以下方式安装：
$ pip install --upgrade-r requirements.txt
前端库被定义为npm依赖项，并且需要这个包 经理待定。
这些依赖项可以通过以下方式安装：
$ python setup.py frontend
安装
该项目作为Pypi package提供，使用pip是首选方法 安装它为此，请使用以下命令；
$ pip install sphinx-docs-theme
如果需要，可以手动安装：
$ python setup.py install
将其用作依赖项
如果项目已安装在本地库存储库中，则可以 只需将以下行添加到任何sphinx的conf.py文件中即可使用 项目：
import sphinx_docs_theme html_theme = 'sphinx_docs_theme' html_theme_path = sphinx_docs_theme.get_html_theme_path()
使用Sphinx Themes文件夹
另一种可能是添加项目代码，包含在 “sphinx_docs_theme”文件夹，到sphinx项目的themes文件夹，其中 是：
docs\_themes\sphinx_docs_theme\
然后只需将以下文件添加到conf.py文件：
html_theme = 'sphinx_docs_theme' html_theme_path = ["_themes", ]
协作
这个项目的任何帮助都会受到欢迎，主要有两个 提供此类帮助的方法：
- 通过问题管理报告错误并请求扩展
- 或者分叉存储库并扩展项目
问题管理
问题在githubproject issues tracker中管理，其中任何github 用户可能会报告错误或要求新功能。
获取代码
如果您希望分叉或修改代码，请访问GitHub project page，其中 总是保留最新版本。查看“master”分支的最新版本 发布，以及当前稳定的开发版本的“开发”。
许可证
项目已在MIT License下发布。
欢迎加入QQ群-->： 979659372
