Easily generate sphinx documentation
Project description
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
yardang-0.1.8.tar.gz
(11.7 kB
view details)
Built Distribution
yardang-0.1.8-py3-none-any.whl
(12.6 kB
view details)
File details
Details for the file yardang-0.1.8.tar.gz.
File metadata
- Download URL: yardang-0.1.8.tar.gz
- Upload date:
- Size: 11.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.11.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 00fca23d059df87a8ad0da0f07e52d20cce2928a117fe14b2eb4bb4aa4f92ec0 |
|
| MD5 | e176b069f72d286a1a63b88aea0ab80e |
|
| BLAKE2b-256 | 02c4c6cecffc0bc494c91de09ad2c395f4f5f1250a16eb8822d9af45316433cb |
File details
Details for the file yardang-0.1.8-py3-none-any.whl.
File metadata
- Download URL: yardang-0.1.8-py3-none-any.whl
- Upload date:
- Size: 12.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.11.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4dcf4ecfddfefe48282322ad37f15593bf1cb632709591fb1adecf3009ba42e7 |
|
| MD5 | 58c060faceb001587c0bae48ef8c849a |
|
| BLAKE2b-256 | 4bd0d747f86955c76794099fafe0f68f1e3bb74dc82ab7cc88894aa24fdc784c |
