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
Metadata
1 maintainer
Release files for yardang 0.11.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| yardang-0.11.0.tar.gz | 49.2 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| yardang-0.11.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 106.4 kB
Release files / yardang-0.11.0.tar.gz
| Download URL | yardang-0.11.0.tar.gz |
|---|---|
| Size | 49.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6b8e01fad2daff3ae4ede152e4c888ba938f4f12c08997beb1c66a64842e38a5
|
|
BLAKE2b-256 checksum How to use checksums |
f40a3847c77845736261fdbae46699851c0e542eabb5990a818cd71ad99475bf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Release files / yardang-0.11.0-py3-none-any.whl
| Download URL | yardang-0.11.0-py3-none-any.whl |
|---|---|
| Size | 57.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d31b6cfaf83925f9fee7b48f8b2356759d864f16cef86cdc2a4b0217d4b38e40
|
|
BLAKE2b-256 checksum How to use checksums |
df7c38120eeb1bd35070dd587ace1fffd8791c7e0c7cef3abe50516fdfb36bb9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Security for yardang 0.11.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
