IATI Sphinx 主题

我该如何使用IATI Sphinx 主题？

请参阅IATI Sphinx 主题文档以获取使用说明。

我该如何为IATI Sphinx 主题做出贡献？

安装依赖项

pip install -r requirements_dev.txt

更新依赖项

python -m piptools compile --extra=dev -o requirements_dev.txt pyproject.toml
pip install -r requirements_dev.txt

运行代码检查

black iati_sphinx_theme/
isort iati_sphinx_theme/
flake8 iati_sphinx_theme/
mypy iati_sphinx_theme/

带实时预览的文档

1. 在一个终端中，以监视模式构建CSS

   npm run build:watch
   

2. 在另一个终端中，安装Sphinx主题然后启动文档开发服务器

   pip install -e .
   sphinx-autobuild -a docs docs/_build/html --watch iati_sphinx_theme/
   

测试主题的本地版本与另一个项目的兼容性

要运行主题的本地版本与另一个项目（例如 my-docs），请按照以下步骤操作

1. 克隆 sphinx-theme 仓库，并切换到您要使用的分支或标签。

2. 在 sphinx-theme 目录中运行以下命令，以构建主题的CSS。

   npm run build
   

3. 进入 my-docs 目录，并安装Sphinx主题

   pip install -e /path/to/sphinx-theme
   

4. 在您的 conf.py 中设置 html_theme 选项

   html_theme = "iati_sphinx_theme"
   

5. 启动文档开发服务器

   pip install sphinx-autobuild
   sphinx-autobuild docs docs/_build/html