```{toctree}
---
maxdepth: 2
hidden: true
---



docs/src/overview.md

docs/src/installation.md

docs/src/configuration.md

docs/src/api.md


```



<div style="display: flex; flex-direction: row; margin-top:50px;">
  <a href="https://github.com/python-project-templates/yardang"><img src="https://github.com/python-project-templates/yardang/blob/main/docs/logo.png?raw=true" alt="yardang" width="120"></a>
  <h1 style="margin-left: 20px;">yardang</h1>
</div>

[![GitHub](https://img.shields.io/badge/repo-github-181717?logo=github&logoColor=white)](https://github.com/python-project-templates/yardang)
[![Build Status](https://github.com/python-project-templates/yardang/actions/workflows/build.yml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/yardang/actions/workflows/build.yml)
[![codecov](https://codecov.io/gh/python-project-templates/yardang/branch/main/graph/badge.svg)](https://codecov.io/gh/python-project-templates/yardang)
[![License](https://img.shields.io/github/license/python-project-templates/yardang)](https://github.com/python-project-templates/yardang)
[![PyPI](https://img.shields.io/pypi/v/yardang.svg)](https://pypi.python.org/pypi/yardang)

`yardang` is a Python library for generating [Sphinx documentation](https://www.sphinx-doc.org/en/master/) easily, with minimal local configuration overhead.

[`yardang`](https://www.britannica.com/science/yardang) makes building [Sphinx](https://www.sphinx-doc.org/en/master/) easy.


::::{grid} 1 2 2 2
:margin: 4 4 0 0
:gutter: 1

:::{grid-item-card} {octicon}`table` Overview
:link: docs/src/overview.html
:link-type: url

About `yardang` and how it works.
:::

:::{grid-item-card} {octicon}`download` Installation
:link: docs/src/installation.html
:link-type: url

Install `yardang` from PyPI, Conda Forge, or build from source.
:::

:::{grid-item-card} {octicon}`gear` Configuration
:link: docs/src/configuration.html
:link-type: url

Learn how to configure your repository.
:::

:::{grid-item-card} {octicon}`mark-github` Repository
:link: https://github.com/python-project-templates/yardang
:link-type: url

Star, Fork, or contribute on GitHub.
:::
::::

-------------

*This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base).*