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
GitHub Action
A convenient github action is provided to publish documentation automatically in CI.
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 }}
1 maintainer
Release files for yardang 0.10.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| yardang-0.10.2.tar.gz | 46.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| yardang-0.10.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 100.5 kB
Release files / yardang-0.10.2.tar.gz
| Download URL | yardang-0.10.2.tar.gz |
|---|---|
| Size | 46.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bf937e047edeaf35513fe2d38480c5ab10945792cbb834b6c87c6a7c8b3fc714
|
|
BLAKE2b-256 checksum How to use checksums |
fb02cc97c43c4797f0263fdccb9ded197d52ec99a1e9dd2a256d81eefaff5e34
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
Release files / yardang-0.10.2-py3-none-any.whl
| Download URL | yardang-0.10.2-py3-none-any.whl |
|---|---|
| Size | 54.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ac25296526bda560268c29c7b2054410e2ab553a7fce1e81104b3ed5bde540da
|
|
BLAKE2b-256 checksum How to use checksums |
97abd079832e4c002542bf0ba0ce090b74cb161300c4e8c851ce8055078a5e0e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
