lsst用户文档的sphinx主题建立在bootstrap和astropy的主题之上。
lsst-sphinx-bootstrap-theme的Python项目详细描述
这是lsst堆栈文档的原型sphinx主题,基于astropy sphinx主题。
开发入门
获取回购:
git clone https://github.com/lsst-sqre/lsst-sphinx-bootstrap-theme cd lsst-sphinx-bootstrap-theme
安装javascript依赖项:
npm install -g gulp-cli npm install
编译资源并继续监视更改:
gulp
代码基方向
- lsst_sphinx_bootstrap_theme/是主题的python包
- static/用于部署到站点上的静态资产。app.css是用gulp生成的,因此不要直接编辑它。
- layout.html是html的主要jinja2模板。其他的html文件是块/部分的。
- scss/包含编译成lsst_sphinx_bootstrap_theme/static/app.css的sass源文件。
吞咽命令
此项目使用Gulp运行其生成管道。 本节介绍可以运行的gulp命令。
咕噜咕噜声
将sass编译成css(app.css)。 我们使用以下功能:
- 编译sass。
- 使用Autoprefixer(通过PostCSS)向css添加前缀。
- 使用gulp clean css清理和压缩css。
您可以单独运行此任务,但通常通过gulp(默认任务)。
大口大口地喝着
自动格式化代码。 见Code style via Prettier。
通过漂亮的代码样式
这个项目使用Prettier来确保sass和javascript的格式符合您的预期。 像大多数项目一样,我们几乎像现在一样使用Prettier。 在.prettierrc.yaml中配置了两个小异常。
您可以通过两种方式运行Prettier:
- 手动,通过运行gulp pretty。
- 自动提交代码。 这被配置为package.json中的预提交挂钩。
注意Prettier’s预提交钩子和分块git提交不能混合使用。 在提交文件中更改行的子集之前,您需要手动运行Prettier。
释放过程
将更改日志(CHANGELOG.rst)、提交和marge工作更新为master。
使用与PEP 440兼容的版本字符串标记发行版:
git tag -s X.Y.Z -m "X.Y.Z"
按下标签:
git tags --push
travis ci管道将创建发布并将其上载到pypi。