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.2.0.tar.gz
(11.7 kB
view details)
Built Distribution
yardang-0.2.0-py3-none-any.whl
(12.6 kB
view details)
File details
Details for the file yardang-0.2.0.tar.gz.
File metadata
- Download URL: yardang-0.2.0.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 | ff85d0a3682fff00be36221862bfa5276c06de3ed5fc27e72e417e71e3eff5a6 |
|
| MD5 | 9580799c464c78a4c9884c98708d92a9 |
|
| BLAKE2b-256 | c5f78700b9cb9f472eb7c33187229b47ec5a467a6bf81f0d8eb81b6470608b82 |
File details
Details for the file yardang-0.2.0-py3-none-any.whl.
File metadata
- Download URL: yardang-0.2.0-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 | 2316b3469a5f9945f74e5f68f2ba21c272e22ec2a82ba655df4e27593ad1e4b8 |
|
| MD5 | 709b4eb6c1977c703f5af3fdf2dc9c4d |
|
| BLAKE2b-256 | efc7d441f481ca8c4af81486e3238dd6063dd37a484c22cfee6083f08400c999 |
