https://github.com/python-project-templates/yardang
yardang is a Python library for generating Sphinx documentation
https://github.com/python-project-templates/yardang
documentation python sphinx
Last synced: about 2 months ago
JSON representation
yardang is a Python library for generating Sphinx documentation
- Host: GitHub
- URL: https://github.com/python-project-templates/yardang
- Owner: python-project-templates
- License: apache-2.0
- Created: 2024-07-21T17:23:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2026-03-01T00:46:07.000Z (about 2 months ago)
- Last Synced: 2026-03-01T03:58:40.883Z (about 2 months ago)
- Topics: documentation, python, sphinx
- Language: Python
- Homepage: http://yardang.python-templates.dev/
- Size: 605 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# yardang
[](https://github.com/python-project-templates/yardang/actions/workflows/build.yaml)
[](https://codecov.io/gh/python-project-templates/yardang)
[](https://github.com/python-project-templates/yardang)
[](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.
## Configuration
Here is `yardang`'s own configuration, in `pyproject.toml`
```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`:
```bash
pip install yardang
```
Or from `conda-forge` via `conda`:
```bash
conda install yardang -c conda-forge
```
## GitHub Action
A convenient [github action](https://github.com/actions-ext/yardang) is provided to publish documentation automatically in CI.
```yaml
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 }}
```
> [!NOTE]
> 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).