跳转到主要内容

轻松生成Sphinx文档

项目描述

yardang

yardang

Build Status codecov License PyPI

yardang 是一个用于轻松生成 Sphinx 文档 的 Python 库,具有最小的本地配置开销。

yardang 使得构建 Sphinx 变得简单。

配置

以下是 yardang 自己的配置,位于 pyproject.toml

[tool.yardang]
root = "docs/src/home.md"
cname = "yardang.python-templates.dev"
pages = [
    "docs/src/overview.md",
    "docs/src/installation.md",
    "docs/src/configuration.md",
]
use-autoapi = true

安装

您可以通过 pip 从 PyPI 安装

pip install yardang

或通过 conda-forge 通过 conda 安装

conda install yardang -c conda-forge

项目详情


下载文件

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

源分布

yardang-0.1.8.tar.gz (11.7 kB 查看哈希)

上传于 来源

构建分发

yardang-0.1.8-py3-none-any.whl (12.6 kB 查看哈希值)

上传于 Python 3

由以下支持