yardang

yardang is a Python library for generating Sphinx documentation easily, with minimal local configuration overhead.

yardang makes building Sphinx easy.

Configuration

Here is yardang's own configuration, in 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

Installation

You can install from PyPI via pip:

pip install yardang

Or from conda-forge via conda:

conda install yardang -c conda-forge

Note

This library was generated using copier from the Base Python Project Template repository.