跳转到主要内容

Sphinx Wagtail 主题

项目描述

Sphinx Wagtail 主题

CI status PyPI version License: MIT

Sphinx Wagtail 主题包含构建提供该主题的 Sphinx 扩展所需的全部文件。

安装

pip install sphinx-wagtail-theme

使用

在 Sphinx 的 conf.py 文件中选择 "Sphinx Wagtail 主题"。

# include the theme in the list of extensions to be loaded
extensions = ['sphinx_wagtail_theme', ]

# select the theme
html_theme = 'sphinx_wagtail_theme'
  • 有关更多使用说明,请参阅文档。

开发

入门指南

发布流程

检查清单

  • CONTRIBUTORS.md 已更新
  • CHANGELOG.md 已更新
  • setup.cfg 已更新(请参阅 version
  • 所有内容均已提交,进行干净签出
  • ~/.pypirc 包含用户名和密码(令牌)
  • 在发布提交中添加一个格式为 X.Y.Z 的 git 标签
  • 针对该标签创建一个格式为 vX.Y.Z 的 GitHub 发布

在有活动的虚拟环境中

python -m pip install --upgrade -r requirements.txt
make clean
make clean-frontend
npm ci
npm run build
prerelease
git tag -a N.N.N -m "N.N.N"
git push origin N.N.N
python -m build
python -m twine upload --repository pypi dist/*
postrelease

致谢

Sphinx Wagtail 主题 基于 Sphinx Typo3 主题,后者基于 t3SphinxThemeRtd,而 t3SphinxThemeRtd 则基于 Read the Docs Sphinx 主题

感谢 Vercel 提供主题预览站点的托管。

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源分布

sphinx_wagtail_theme-6.3.0.tar.gz (2.0 MB 查看哈希值)

上传时间

构建分布

sphinx_wagtail_theme-6.3.0-py2.py3-none-any.whl (2.0 MB 查看哈希值)

上传时间 Python 2 Python 3

由以下组织支持