Skip to content

docs: link the generated API reference from the README - #21

Merged
adilfaisal01 merged 1 commit into
mainfrom
docs/readme-api-link
Sep 15, 2026
Merged

adilfaisal01 merged 1 commit into
mainfrom
docs/readme-api-link

Conversation

@adilfaisal01

Copy link
Copy Markdown
Member

What

The API reference is already deployed to GitHub Pages (PR #20, workflow run 34995467734 — success), but nothing in the repo points at it. This adds the link.

Live now: https://shinro-xyz.github.io/shinro-python-modules/

Changes

README.md — two additions:

  1. A badge under the title, so it's visible on the repo landing page:
[![API Reference](https://img.shields.io/badge/API%20Reference-shinro--xyz.github.io-blue)](https://shinro-xyz.github.io/shinro-python-modules/)
  1. An entry in the existing Documentation section, right after the docs.shinro.xyz guides, describing what it covers and noting it's generated:

API Referencehttps://shinro-xyz.github.io/shinro-python-modules/
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.

mkdocs.yml — sets site_url, which was unset. Canonical URLs, the generated sitemap, and search relevance all depend on it.

Placement note

I put this alongside the docs.shinro.xyz links rather than replacing them — they're different things:

  • docs.shinro.xyz — hand-written conceptual/operational guides
  • GitHub Pages — generated per-symbol API reference

Happy to merge them onto one domain later, but that's a separate decision.

Verification

Check Result
Live page HTTP 200, title Home - shinro
Diff vs main 2 files, no collateral
Commit parent origin/main (a50a2cb)

Generated with Hermes Agent

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.
@adilfaisal01
adilfaisal01 merged commit 2dabf48 into main Sep 15, 2026
3 checks passed
@adilfaisal01
adilfaisal01 deleted the docs/readme-api-link branch September 16, 2026 00:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant