Easily generate sphinx documentation

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for timkpaine from gravatar.com timkpaine

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache-2.0
  • Author: the yardang authors
  • Requires: Python >=3.9
  • Provides-Extra: develop
Classifiers

Project description

yardang

yardang

Build Status codecov License PyPI

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

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page