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.7.tar.gz
(11.3 kB
view details)
Built Distribution
yardang-0.1.7-py3-none-any.whl
(12.2 kB
view details)
File details
Details for the file yardang-0.1.7.tar.gz.
File metadata
- Download URL: yardang-0.1.7.tar.gz
- Upload date:
- Size: 11.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.11.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 47568f63973e05a468c64bd85b58a5afec813cc2c42d08304d617b6bc9c5eaef |
|
| MD5 | 19620266b5694f0061789e6a4b328850 |
|
| BLAKE2b-256 | 874022ed66b8b1ebcffcce8541b0d41667c3c01e7a79609dd51f0411bcec2999 |
File details
Details for the file yardang-0.1.7-py3-none-any.whl.
File metadata
- Download URL: yardang-0.1.7-py3-none-any.whl
- Upload date:
- Size: 12.2 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 | 8587cb5777e4868031f31faf43f48cb6d2579d2d07474c650a0567a2e2bee27d |
|
| MD5 | 37726df9072cf174335bfce192450503 |
|
| BLAKE2b-256 | c1b063785ebf8e8a3c3f4d2e3bce16bcfb2bf4422046d385e71d22ace3793815 |
