Skip to content

Fix Sphinx docs build errors - #104

Draft
yutkin wants to merge 1 commit into
masterfrom
fix/sphinx-docs-build
Draft

yutkin wants to merge 1 commit into
masterfrom
fix/sphinx-docs-build

Conversation

@yutkin

@yutkin yutkin commented Oct 30, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR fixes the Sphinx docs build. It changes only files under docs/source/.

 docs/source/api/services/*.rst          # 9 service pages
-.. autoclass:: verda.containers.containers.ContainersService
+.. autoclass:: verda.containers.ContainersService
 docs/source/changelog.rst
-.. include:: ../../CHANGELOG.rst
+.. include:: ../../CHANGELOG.md
+   :parser: recommonmark
 docs/source/contributing.rst
-.. include:: ../../CONTRIBUTING.rst
+.. include:: ../../CONTRIBUTING.md
+   :parser: recommonmark
 docs/source/examples/containers/index.rst
   inference_minimal
+  inference_minimal_async
  • The service pages named modules that do not exist, so autodoc imported nothing. The pages now use the public import paths. Each package __init__.py exports these names.
  • The changelog and contributing pages included .rst files that do not exist, so the pages had no content and no title. They now include the .md files with recommonmark, which docs/requirements.txt already installs.
  • inference_minimal_async was in no toctree.

Evidence

sphinx-build -b html docs/source <out>, with the packages from docs/requirements.txt (Sphinx 9.2.0, docutils 0.23, recommonmark 0.7.1):

  • Before (master): 113 warnings and 2 errors.
    • 18 autodoc import failures
    • 2 include errors (CHANGELOG.rst, CONTRIBUTING.rst)
    • 94 toc.no_title warnings for changelog and contributing
    • 1 toc.not_included warning for inference_minimal_async
  • After: 0 warnings and 1 error. The service API pages, the changelog and the contributing page render with content.

The remaining error is in the InstancesService.action docstring: Unexpected indentation. It existed before, but the build did not show it because autodoc could not import the module. The docstrings use Google style, and conf.py does not enable sphinx.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

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

No deployments
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