斯芬克斯的苹果开发者连接主题,2015版。

sphinx_adc_theme的Python项目详细描述


https://travis-ci.org/mga-sphinx/sphinx_adc_theme.svg?branch=master

这是为adc创建的sphinx主题。

检查demo

Installation

Via package

下载包或将其添加到requirements.txt文件:

$ pip install sphinx_adc_theme

conf.py文件中:

importsphinx_adc_themehtml_theme="sphinx_adc_theme"html_theme_path=[sphinx_adc_theme.get_html_theme_path()]

Via git or download

sphinx_adc_theme/sphinx_adc_theme存储库符号链接或子树到 docs/_themes/sphinx_adc_theme然后将以下两个设置添加到sphinx conf.py文件:

html_theme="sphinx_adc_theme"html_theme_path=["_themes",]

Changelog

请参见changelog.rst文件

Contributing or modifying the theme

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

Set up your environment

  1. sphinx安装到虚拟环境中。
pip install sphinx
  1. 安装sass
gem install sass
  1. 安装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

此默认任务将执行以下非常酷的操作,值得您费心。

  1. 它将安装和更新任何bower依赖项。
  2. 它将运行sphinx并构建新的文档。
  3. 它将监视sass文件的更改,并根据更改构建css。
  4. 只要注意到.rst、.html、.js的更改,它就会重新生成sphinx文档。 或.css文件。

Before you create an issue

由于其他责任,我没有很多时间来维护这个项目。 我知道有很多python工程师不能编写sass/css和 无法提交请求。也就是说,提交随机样式错误 至少提供复制问题的示例文档是一个好方法 让我无视你的要求。不幸的是,rst会吐出很多东西 在很多方面。我没有时间为你研究你的问题,但我有时间 如果你能为我复制这个问题,就有时间来解决实际的样式问题。

Before you send a Pull Request

完成编辑后,可以运行grunt build来清除旧的 文件和重建新的发行版,压缩css并清除 无关文件。请在发送PR之前执行此操作。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
在GlassFish v2中同时使用两个EntityManager时出现java错误   java中字符串生成器到字符串数组   Java中的引用传递值   java无法在Motox中查看日期和时间   java rest web服务中的默认http方法是什么   java向Android视图添加一些自定义事件/Linstener,如ListView   java试图在系统中实现变量Int。出来总体安排   java为什么这些可调用函数永远无法完成?   javacom。mysql。jdbc。MysqlDataTruncation:数据截断:第1行“DATE”列的数据太长   java如何从底部工作表对话框类使用onActivityResult   意外的Vaadin会话已过期,并行spring引导应用程序   如何在Java中比较和排序两个ArrayList   使用Grunt任务运行java自动化测试   java多线程WebSocket   组上的java JPA标准API空检查   java合并ArryList并另存为arraylist与in arraylist   mongodb Java如何从MongoDatabase类中获取DB对象作为MongoClient。getDB(dbName)已被弃用   用Java绘制JFreeChart的折线图   java如何将Springbean从spring上下文外部注册到spring上下文中?