跳转到主要内容

Sphinx Readable Theme

项目描述

一个简洁且易于阅读的 Sphinx 主题,重点在于 autodoc – 来自docstrings的文档。

flask-sphinx-themes 启发。

安装和设置

从PyPI安装

$ pip install sphinx-readable-theme

并将其添加到您的 conf.py

import sphinx_readable_theme

html_theme_path = [sphinx_readable_theme.get_html_theme_path()]
html_theme = 'readable'

文档和示例

带有示例的文档可在 https://sphinx-readable-theme.readthedocs.org 找到

许可证

Sphinx Readable Theme 在MIT许可证下授权。

变更日志

版本 1.3.0

  • 修复了搜索结果的填充 - 感谢,Matt Bennett!

版本 1.2.0

  • 添加了 <code> 标签的样式,它替换了Sphinx 1.3中的 <tt>

版本 1.1.0

  • 修复了脚注表格的宽度 - 感谢,Nick Zaccardi!

版本 1.0.0

  • 修复了长有序和无序列表项中的续行符

  • 修复了Autodoc示例中的引用

版本 0.1.0

首次发布

项目详情


下载文件

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

源分布

sphinx-readable-theme-1.3.0.tar.gz (11.5 kB 查看散列值)

上传于 源代码

支持者

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面