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

GitHub Action

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 }}

Release files for yardang 0.10.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for yardang 0.10.1
File	Size	Uploaded
yardang-0.10.1.tar.gz	46.2 kB	Sep 17, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for yardang 0.10.1
File	Interpreter	ABI	Platform	Reset
yardang-0.10.1-py3-none-any.whl 53.8 kB Sep 17, 2026	Python 3	none	any	Details

Total release size: 100.1 kB

Release files / yardang-0.10.1.tar.gz

Download URL	yardang-0.10.1.tar.gz
Size	46.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`ba212a4cbd7ad91d9fa064bc98506b8d26a7b48601e275c77c029411b1b94c85`
BLAKE2b-256 checksum How to use checksums	`8d2d2f65104f0eadb4aec2a9760256a98dcd916f6290c8dfe4500abbeb47dbad`
Upload date	Sep 17, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`

Release files / yardang-0.10.1-py3-none-any.whl

Download URL	yardang-0.10.1-py3-none-any.whl
Size	53.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`b5f89e2687d938107c067a05e3b3457f9e3b3eb99bc51c0e4c08961a696da59e`
BLAKE2b-256 checksum How to use checksums	`50fbf19de5b81c401b479088d84f65213dbb3176e9b0cfe3ac3957ac0c2cc1a1`
Upload date	Sep 17, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`