renku-sphinx-theme 0.4.0

安装

1. 将 renku-sphinx-theme 添加到用于构建您文档的 setup.py 或 requirements.txt。

2. 在 docs/conf.py 中将 html_theme 设置为 'renku'。

3. 在 html_theme_options 中至少配置 description 和 github_repo。

享受您漂亮的Renku文档风格。

样式（CSS）

此仓库包含一个scss文件，该文件生成一个css文件。由于使用scss生成，因此不应手动修改css文件。更改和运行scss文件的说明在scss文件内。

在这个存储库中进行样式更改的简单方法是前往renku存储库，在docs/conf.py文件中添加一个临时CSS（custom.css），然后按照以下步骤操作

https://renku.readthedocs.io/zh/latest/developer/contributing/documentation.html

这样做的原因是renku文档是测试更改的更好的存储库。

在临时CSS中完成更改后，将此内容添加到本存储库中的custom.scss文件中，按照说明将其构建为CSS文件，并提交CSS和SCSS文件。

构建

在更改后构建文档，并测试本存储库中的内容

1. 从基本文件夹… pip install -r docs/requirements.txt

2. 如果字体或添加了新的CSS文件，则应执行此操作 pip install --editable .

3. 这里没有Makefile，但为了执行“make html”操作，您应该这样做

   cd docs sphinx-build -b html -d _build/doctrees . _build/html

文档将被构建到_build/html... 使用chrome打开此文件以查看更改。

发布

1. 创建一个拉取请求，更新renku_sphinx_theme/version.py到新版本号，并将CHANGES.rst更新为列出新更改。

2. 一旦拉取请求被合并，[创建一个新的发布](https://github.com/SwissDataScienceCenter/renku-sphinx-theme/releases/new)。

3. 发布将被自动推送到[PyPI](https://pypi.ac.cn/project/renku-sphinx-theme/)。

0.3.0 (2023-08-14)

重大依赖关系更新。

0.2.3 (2023-04-26)

• chore: 添加dependabot.yml (76baee5)

• chore: 删除对不存在的compile-scss的依赖 (617e566)

• chore: 修复pypi描述 (23536d9)

• chore(deps): 更新sphinx-rtd-theme需求 (2ca96ca)

• chore: 升级python版本 (0dd1fe6)

• chore: 删除layout.html (5fa988d)

• fix: 更新样式以修复侧边栏背景泄露到主要内容中 (5ab737b)

0.2.2 (2021-07-09)

• design: renku-sphinx的新设计 (3cf7ec7)

• chore: 用github actions替换travis CI (4056830)

0.1.0 (2018-05-17)

• 首次公开发布。