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

yardang makes building Sphinx easy.

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

You can install from PyPI via pip:

pip install yardang

Or from conda-forge via conda:

conda install yardang -c conda-forge

A convenient github action is provided to publish documentation automatically in CI.

name: Docs on: push: branches: ["main"] tags: ["v*"] workflow_dispatch: permissions: contents: write jobs: docs: runs-on: ubuntu-latest steps: - uses: actions-ext/yardang@main with: token: ${{ secrets.GITHUB_TOKEN }}