From 1e2cc73234adfc1d1a8455d9a6b50d98b4f3dc15 Mon Sep 17 00:00:00 2001 From: Adil Faisal Date: Tue, 15 Sep 2026 12:35:35 -0400 Subject: [PATCH] docs: link the generated API reference from the README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The API reference is now deployed to GitHub Pages, but nothing in the repo points at it. Adds a badge under the title and an entry in the Documentation section alongside the docs.shinro.xyz guides. Live: https://shinro-xyz.github.io/shinro-python-modules/ Also sets mkdocs site_url, which was unset — canonical URLs, the generated sitemap and search relevance all depend on it. --- README.md | 8 ++++++++ mkdocs.yml | 1 + 2 files changed, 9 insertions(+) diff --git a/README.md b/README.md index 419b59b..31f6ac0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Shinro Python Modules +[![API Reference](https://img.shields.io/badge/API%20Reference-shinro--xyz.github.io-blue)](https://shinro-xyz.github.io/shinro-python-modules/) + A clean, modular Python control framework built on five abstract base classes — **Controller**, **Plant**, **StateEstimator**, **TrajectoryGenerator**, and **PhysicsEngine** — with registry-based factories that compose them from TOML @@ -19,6 +21,12 @@ Conceptual and operational documentation lives in - **[Control Architecture](https://docs.shinro.xyz/control-architecture/)** — why the five ABCs exist, how they compose, sim/hardware parity - **[Python Modules](https://docs.shinro.xyz/python-modules/)** — the operational guide: install, run, extend, component catalog +**API Reference** — +Every exported symbol — the five ABCs, controllers, estimators, plants, +trajectories, factories, utilities — with signatures, parameter tables and +source links. Generated from the package's own `__all__` on every push, so it +cannot go stale. + The same guides live in-repo under [`docs/`](./docs/) (no internet required): - **[`docs/quickstart.md`](./docs/quickstart.md)** — install → build a controller from TOML → run a scenario → trace/lower. Start here. diff --git a/mkdocs.yml b/mkdocs.yml index 7b687fa..c4775e4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,6 +8,7 @@ # from each subpackage's __all__. Only prose pages are declared by hand below. site_name: shinro +site_url: https://shinro-xyz.github.io/shinro-python-modules/ site_description: Whole-body control framework — controllers, plants, estimators, trajectories, and a MuJoCo-backed simulation factory. docs_dir: docs site_dir: site