Sphinx主题，基于Bootstrap和Astropy主题构建的LSST用户文档。
项目描述
这是一个基于Astropy Sphinx主题的LSST Stack文档的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 运行其构建管道。本节描述您可以运行的gulp命令。
gulp
使用此默认命令进行开发。它执行以下操作
sass (编译Sass)
监视更改并在必要时重新编译资产。
gulp scss
将 Sass 编译成 CSS (app.css)。我们使用以下功能：
编译 Sass。
使用 Autoprefixer (通过 PostCSS) 为 CSS 添加前缀。
使用 gulp-clean-css 清理和压缩 CSS。
您可以单独运行此任务，但通常通过 gulp (默认任务) 来运行。
gulp pretty
自动格式化代码。请参阅 通过 Prettier 的代码风格。
通过 Prettier 的代码风格
该项目使用 Prettier 来确保 Sass 和 JavaScript 按照您的预期进行格式化。像大多数项目一样，我们几乎原样使用了 Prettier。在 .prettierrc.yaml 中配置了一些小的例外。
您可以通过以下两种方式运行 Prettier：
手动运行，通过运行 gulp pretty。
自动运行，通过提交代码。这已在 package.json 中的预提交钩子中进行配置。
请注意，Prettier 的预提交钩子和分块 Git 提交不兼容。您将在提交文件中更改行的一部分之前手动运行 Prettier。
发布流程
更新变更日志 (CHANGELOG.rst)，提交，并将工作合并到 master。
使用兼容 PEP 440 的版本字符串标记发布。
git tag -s X.Y.Z -m "X.Y.Z"
推送标签
git tags --push
Travis CI 流水线将创建和上传发布到 PyPI。
lsst-sphinx-bootstrap-theme-0.2.2.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 71c14b309cac280301facdd6db4fc43be9b95962e20c16bb84678fd813f2d2a1 |
|
| MD5 | cde9b2bf762abdcce2ae95f698ee0b95 |
|
| BLAKE2b-256 | 7da89f6da99fcea15d7b8228d1550732b319068d4d8a676ede5015e3c73dcfbe |
