Repository navigation
Conversation
Point the service API pages at the public import paths, such as verda.containers.ContainersService. The old paths named modules that no longer exist, so autodoc could not import them. Include CHANGELOG.md and CONTRIBUTING.md with the recommonmark parser. The pages referenced .rst files that no longer exist, so they had no content and no title. Add inference_minimal_async to the container examples toctree. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This branch has not been deployed
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.
Summary
This PR fixes the Sphinx docs build. It changes only files under
docs/source/.__init__.pyexports these names..rstfiles that do not exist, so the pages had no content and no title. They now include the.mdfiles with recommonmark, whichdocs/requirements.txtalready installs.inference_minimal_asyncwas in no toctree.Evidence
sphinx-build -b html docs/source <out>, with the packages fromdocs/requirements.txt(Sphinx 9.2.0, docutils 0.23, recommonmark 0.7.1):CHANGELOG.rst,CONTRIBUTING.rst)toc.no_titlewarnings for changelog and contributingtoc.not_includedwarning forinference_minimal_asyncThe remaining error is in the
InstancesService.actiondocstring:Unexpected indentation. It existed before, but the build did not show it because autodoc could not import the module. The docstrings use Google style, andconf.pydoes not enablesphinx.ext.napoleon. This PR does not change that.Merge Danger
Door: two-way
A revert restores the old docs pages.
Blast Radius: docs
The change affects only the generated docs. It does not change package code, tests or dependencies. The API pages now show content that the docs did not show before. The
Args:sections in that content render as plain text until napoleon is enabled.🤖 Generated with Claude Code