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.3
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.3.tar.gz | 43.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| yardang-0.9.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 94.7 kB
Release files / yardang-0.9.3.tar.gz
| Download URL | yardang-0.9.3.tar.gz |
|---|---|
| Size | 43.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
736e3ee2b2857f520cbad235ebc7166c48ec45e62dcda89b4cefd02c131d2144
|
|
BLAKE2b-256 checksum How to use checksums |
b0e906cf32224b7ed4daa655379797226361291759b323f993a52d2ab2e560ed
|
| 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.3-py3-none-any.whl
| Download URL | yardang-0.9.3-py3-none-any.whl |
|---|---|
| Size | 50.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
54227f9282294d030841fa1d668492f0d3b3135daf4dd8c141e9a5be48a0dae7
|
|
BLAKE2b-256 checksum How to use checksums |
ae9d762b94c6270c3073ebb67f0cf983c8c5144b3083ea9052b64fbd9ddfc80c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
