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 }}
[!NOTE] This library was generated using copier from the Base Python Project Template repository.
1 maintainer
Release files for yardang 0.9.4
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.9.4.tar.gz | 43.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| yardang-0.9.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 94.7 kB
Release files / yardang-0.9.4.tar.gz
| Download URL | yardang-0.9.4.tar.gz |
|---|---|
| Size | 43.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6369f191e5577a004c920b791f2c93f037ed6f02275206306f8489653b36fbb7
|
|
BLAKE2b-256 checksum How to use checksums |
df5566c185fc636bd0b65e3ec4afb2c244a7e26dee033fd98b3738d4cc0659cb
|
| 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.9.4-py3-none-any.whl
| Download URL | yardang-0.9.4-py3-none-any.whl |
|---|---|
| Size | 50.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d7f174efec701aa6602c1b3897d39bc6ad4be419f87fe4163942a0ae122a0199
|
|
BLAKE2b-256 checksum How to use checksums |
77f5487174c07cca3e41712d428da0c00ae939b2b22180556443b35a8330b4dc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
