Files
Jungfraujoch/docs/PYTHON_CLIENT.md
T
leonarski_fandClaude Opus 5 784cf87cc8 docs: put the generated python-client reference behind one landing page
The OpenAPI Python client owned the sidebar: DefaultApi's 128 method anchors
plus the 64 hidden-glob model pages were 195 of its 256 entries, because
sphinx_material's globaltoc includes hidden toctrees by default. A new
PYTHON_CLIENT.md landing page carries the links and a hidden glob toctree, and
globaltoc_includehidden is off, so every generated page is still built and
reachable (verified: 64 model pages + DefaultApi render, zero warnings) while
the sidebar drops to 61 entries. docs/review/ joins exclude_patterns so a
local, gitignored review report can never again be rendered into the
published site.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EFEJG6WBQv8th4UJFNe53N
2026-09-02 09:18:36 +02:00

845 B

OpenAPI Python client

The broker's REST API has a generated Python client, published on PyPI as jfjoch-client and regenerated from broker/jfjoch_api.yaml by update_version.sh — the YAML is the single source of truth (see OpenAPI).

  • Client README — installation, quick start, and the index of every endpoint and model.
  • DefaultApi — the full endpoint reference, with a generated example per call.

The per-model pages are generated as well and are linked from the two pages above. They are built with the site but kept out of the navigation sidebar on purpose — sixty generated reference pages would otherwise be most of it.

:hidden:
:glob:

python_client/README
python_client/docs/*