Repository navigation
Conversation
Landing page, getting started, guides, generated API reference (resources and ~640 types grouped by domain), project pages, llms.txt and llms-full.txt. Raises sections in generated docstrings now use 'Name: description' so mkdocstrings parses them.
tests/test_docs_coverage.py checks that every resource, method, export and type is in the reference, that exported classes have docstrings, that docs/guides/index.md lists every resource group, and that guides only reference API that exists. Ruff D1 covers public modules. Adds the missing docstrings it found and a guide index page.
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
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.
Adds a MkDocs Material site for https://shrijayan.github.io/opencode-python-sdk/.
docs/hooks/types_reference.pyllms.txtandllms-full.txtwritten on build.github/workflows/docs.yml:mkdocs build --stricton PRs, deploy to Pages on push tomaindocsdependency group; README,DocumentationURL and CONTRIBUTING updatedsrc/change is docstring-only: the generator now emitsRaises:entries asName: The server answered <status>.so griffe parses them (regenerated viapython -m codegen).Docs coverage gate
tests/test_docs_coverage.py(runs in the existing pytest jobs) fails when a resource/method,opencode.__all__name oropencode.typesmodel is missing from the reference, when an exported class or its public members lack docstrings, whendocs/guides/index.mdmisses a resource group, or when a guide references a method/type that no longer exists. Failures name the item and the file to edit.D1enabled for the published package (it skips_privatemodules, which the test covers)._exceptions.pyand_server.pyadded.