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.6.tar.gz
(10.9 kB
view details)
Built Distribution
yardang-0.1.6-py3-none-any.whl
(11.7 kB
view details)
File details
Details for the file yardang-0.1.6.tar.gz.
File metadata
- Download URL: yardang-0.1.6.tar.gz
- Upload date:
- Size: 10.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 395146aad040a57f25901d53d0d935953507b85eb92f3815fc36e7dae149efec |
|
| MD5 | 1d5dbd95f93c463befd17582af4b6dec |
|
| BLAKE2b-256 | 6907b95e5a9d2cc5606e844818cba8fc577367b5e637ccbc1b384fc7ac7b2a44 |
File details
Details for the file yardang-0.1.6-py3-none-any.whl.
File metadata
- Download URL: yardang-0.1.6-py3-none-any.whl
- Upload date:
- Size: 11.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e575f9c302fd596de55c7a35d6edd7039d471c87bf3eb6dda84379417dd737b1 |
|
| MD5 | 8999010d40a5badc172ad0d9c6a1258c |
|
| BLAKE2b-256 | d4dca1508e88c7ad46c5966a84253b865a1fed57747384af2fcd131a88d6c271 |
