{"id":46309964,"url":"https://github.com/python-project-templates/yardang","last_synced_at":"2026-03-04T13:01:36.137Z","repository":{"id":249560905,"uuid":"831811733","full_name":"python-project-templates/yardang","owner":"python-project-templates","description":"yardang is a Python library for generating Sphinx documentation","archived":false,"fork":false,"pushed_at":"2026-03-01T00:46:07.000Z","size":620,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-01T03:58:40.883Z","etag":null,"topics":["documentation","python","sphinx"],"latest_commit_sha":null,"homepage":"http://yardang.python-templates.dev/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/python-project-templates.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-07-21T17:23:14.000Z","updated_at":"2026-03-01T00:44:42.000Z","dependencies_parsed_at":"2024-08-09T01:44:38.372Z","dependency_job_id":"d7d1df86-fd0d-4136-bb8c-9a0b4301dbb3","html_url":"https://github.com/python-project-templates/yardang","commit_stats":null,"previous_names":["python-project-templates/yardang"],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/python-project-templates/yardang","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/python-project-templates%2Fyardang","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/python-project-templates%2Fyardang/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/python-project-templates%2Fyardang/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/python-project-templates%2Fyardang/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/python-project-templates","download_url":"https://codeload.github.com/python-project-templates/yardang/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/python-project-templates%2Fyardang/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30081057,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T12:28:08.313Z","status":"ssl_error","status_checked_at":"2026-03-04T12:27:28.210Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","python","sphinx"],"created_at":"2026-03-04T13:01:35.593Z","updated_at":"2026-03-04T13:01:36.130Z","avatar_url":"https://github.com/python-project-templates.png","language":"Python","readme":"\u003ca href=\"https://github.com/python-project-templates/yardang\"\u003e\u003cimg src=\"https://github.com/python-project-templates/yardang/blob/main/docs/logo.png?raw=true\" alt=\"yardang\" width=\"120\"\u003e\u003c/a\u003e\n\n# yardang\n\n[![Build Status](https://github.com/python-project-templates/yardang/actions/workflows/build.yaml/badge.svg?branch=main\u0026event=push)](https://github.com/python-project-templates/yardang/actions/workflows/build.yaml)\n[![codecov](https://codecov.io/gh/python-project-templates/yardang/branch/main/graph/badge.svg)](https://codecov.io/gh/python-project-templates/yardang)\n[![License](https://img.shields.io/github/license/python-project-templates/yardang)](https://github.com/python-project-templates/yardang)\n[![PyPI](https://img.shields.io/pypi/v/yardang.svg)](https://pypi.python.org/pypi/yardang)\n\n`yardang` is a Python library for generating [Sphinx documentation](https://www.sphinx-doc.org/en/master/) easily, with minimal local configuration overhead.\n\n[`yardang`](https://www.britannica.com/science/yardang) makes building [Sphinx](https://www.sphinx-doc.org/en/master/) easy.\n\n## Configuration\n\nHere is `yardang`'s own configuration, in `pyproject.toml`\n\n```toml\n[tool.yardang]\nroot = \"docs/src/home.md\"\ncname = \"yardang.python-templates.dev\"\npages = [\n    \"docs/src/overview.md\",\n    \"docs/src/installation.md\",\n    \"docs/src/configuration.md\",\n]\nuse-autoapi = true\n```\n\n## Installation\n\nYou can install from PyPI via `pip`:\n\n```bash\npip install yardang\n```\n\nOr from `conda-forge` via `conda`:\n\n```bash\nconda install yardang -c conda-forge\n```\n\n## GitHub Action\n\nA convenient [github action](https://github.com/actions-ext/yardang) is provided to publish documentation automatically in CI.\n\n```yaml\nname: Docs\non:\n  push:\n    branches: [\"main\"]\n    tags: [\"v*\"]\n  workflow_dispatch:\npermissions:\n    contents: write\njobs:\n  docs:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions-ext/yardang@main\n        with:\n          token: ${{ secrets.GITHUB_TOKEN }}\n```\n\n\u003e [!NOTE]\n\u003e This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpython-project-templates%2Fyardang","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpython-project-templates%2Fyardang","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpython-project-templates%2Fyardang/lists"}