add cmem-client documentation and update task to refresh documentation - #246
Open
louiswesterheide wants to merge 14 commits into
Open
add cmem-client documentation and update task to refresh documentation#246louiswesterheide wants to merge 14 commits into
louiswesterheide wants to merge 14 commits into
Conversation
Test Results1 files 1 suites 0s ⏱️ For more details on these failures, see this check. Results for commit 8c91034. ♻️ This comment has been updated with latest results. |
The introduction now says what the library actually is: one client object hiding the split between Build, the Explore backend, Keycloak and the Marketplace, with validated responses, typing, dict-like collections and configurable logging on top of plain HTTP calls. It also states how to get the package, that it needs Python 3.13, that cmemc is based solely on it since v26.2, and how it relates to the deprecated cmempy API. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CZVuTrBZ8Z1wtMGAj3Yn6h
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/develop/cmem-client-api/, replacing the oldcmempyAPI docs link on the develop landing page. Content is generated from thecmem-clientpackage's own docstrings (via that repo'setc/export_api_md.py), not hand-written.task update:cmem-client-apito regenerate this section from a localcmem-clientcheckout (CMEM_CLIENT_DIR=/path/to/cmem-client task update:cmem-client-api), running the export and thenrumdl --fixover the result..markdownlint.jsonc: allow<code>inline HTML (MD033) — used by the generated docs to embed links inside type signatures — and disable MD051 (link-fragment check), since rumdl doesn't recognize theattr_list-style explicit heading anchors ({#full.dotted.path}) mkdocstrings/griffe2md need for unique, linkable API anchors..envsupport (dotenv: ['.env']inTaskfile.yml,.envgitignored) for locally configuring things likeCMEM_CLIENT_DIR.