Fix missing Autodoc rendered result on Read the Docs

[chrizzFTD]

Problem

The Autodoc section on the live docs site shows an empty "Rendered result:" block — no function signature, docstring, or interactive REPL.

• Broken: https://sphinx-pyrepl-web.readthedocs.io/en/latest/ (stable)
• Working (PR Local wheels, config-driven autodoc REPLs, and pyrepl-web re-vendor #16 preview): https://sphinx-pyrepl-web--16.org.readthedocs.build/en/16/#autodoc

Root cause

PR #16 (5b9fcee) added autodoc integration and included pyrepl_test_pkg in the [docs] extra so Sphinx could import the module at build time:

docs = [
    "myst-parser",
    "pyrepl_test_pkg @ file:./tests/fixtures/pyrepl_test_pkg",
]

Commit 33a4ea7 correctly removed that local path dependency so the package could be published to PyPI (PyPI rejects file: URLs in optional extras). However, .readthedocs.yml was not updated — RTD still only runs:

pip install .[docs]

Without pyrepl_test_pkg installed, autodoc fails to import the documented object:

WARNING: autodoc: failed to import 'demo.example_generator' from module 'pyrepl_test_pkg'
ModuleNotFoundError: No module named 'pyrepl_test_pkg'

The .. autofunction:: pyrepl_test_pkg.demo.example_generator directive in docs/example.rst then renders nothing. The committed wheel under docs/_static/wheels/ is fine; the build-time import is what was missing.

Fix

Install the fixture package separately on Read the Docs, matching the local dev instructions already in docs/development.rst:

- method: pip
  path: tests/fixtures/pyrepl_test_pkg

Verification

Simulated the RTD install locally:

pip install -e ".[docs]"
pip install -e tests/fixtures/pyrepl_test_pkg
python -m sphinx -b html docs docs/_build

• No autodoc import warnings
• example_generator and <py-repl> widgets present in built HTML

Optional follow-ups (out of scope for this PR)

• Add a CI job that builds docs with the same install steps to catch this class of regression
• Consider an RTD pre_build step running scripts/build_test_pkg_wheel.py if the fixture source changes without updating the committed wheel

  

[read-the-docs-community]

Documentation build overview

📚 sphinx-pyrepl-web | 🛠️ Build #33450648 | 📁 Comparing 0f1c249 against latest (33a4ea7)

  🔍 Preview build  

2 files changed

± genindex.html
± index.html