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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file yardang-0.6.1.tar.gz.
File metadata
- Download URL: yardang-0.6.1.tar.gz
- Upload date:
- Size: 35.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e1aeae5c875d28493e561ec6d57cebf2c52c698125fae00912be0ed290e05cc9
|
|
| MD5 |
f24225d62903f74e8b66d6bc2dcc6cb2
|
|
| BLAKE2b-256 |
5399bd624fb55fdc69e3861941f89ac6e9da171d1ba78b09657b7fa3acd2a88d
|
File details
Details for the file yardang-0.6.1-py3-none-any.whl.
File metadata
- Download URL: yardang-0.6.1-py3-none-any.whl
- Upload date:
- Size: 40.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
720c787d14d2636e51fc3018f02952679f931d1380e4c0fe755735f943c4fefa
|
|
| MD5 |
cce98590971751ad47f5d56b94535ee6
|
|
| BLAKE2b-256 |
07070927dd652bb5811a57a7455403d3c04dcc6d0b0eae8b207adc800c077b1a
|
