geopython / geopython/GeoHealthCheck
GHC Documentation on ReadTheDocs has no autoapi docs
- Dominant language
- Python
- Stars
- 92
- Forks
- 75
- PR merge metrics
- No merged PRs in 30d
Description
**Describe the bug**
Local docs build include the autoapi docs. GHC Documentation on ReadTheDocs (RTD) has no autoapi docs
**To Reproduce**
1. Trigger docs build on RTD
2. Look at autoapi sections
3. These are empty
4. Seeing error in RTD build log
**Expected Behavior**
Docs build should include the autoapi docs.
**Screenshots or Logfiles**
For example https://app.readthedocs.org/projects/geohealthcheck/builds/33686079/ shows:
```
Successfully installed PyYAML-6.0.3 alabaster-0.7.16 astroid-4.1.2 docutils-0.18.1 sphinx-7.3.7 sphinx-autoapi-3.5.0 sphinx-rtd-theme-1.3.0 sphinxcontrib-jquery-4.1
--
| python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html
| Running Sphinx v7.3.7
| [AutoAPI] Ignoring directory: /home/docs/checkouts/readthedocs.org/user_builds/geohealthcheck/checkouts/latest/GeoHealthCheck/migrations/
| [AutoAPI] Reading files... [ 2%] /home/docs/checkouts/readthedocs.org/user_builds/geohealthcheck/checkouts/latest/GeoHealthCheck/check.py
| WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/geohealthcheck/checkouts/latest/GeoHealthCheck/check.py
| [AutoAPI] Reading files... [ 5%] /home/docs/checkouts/readthedocs.org/user_builds/geohealthcheck/checkouts/latest/GeoHealthCheck/config_main.py
| WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/geohealthcheck/checkouts/latest/GeoHealthCheck/config_main.py
| [AutoAPI] Reading files... [ 7%] /home/docs/checkouts/readthedocs.org/user_builds/geohealthcheck/checkouts/latest/GeoHealthCheck/views.py
| WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/geohealthcheck/checkouts/latest/GeoHealthCheck/views.py
|
```
**Context (please complete the following information):**
- OS: GH Workflow Build env
- Browser [e.g. chrome, safari]
- Browser Version [e.g. 22]
- Python Version [e.g. 2.7]
- GeoHealthCheck Version [e.g. 0.7.0]
If running with Docker:
- Docker installed version
- GeoHealthCheck Docker Image version
**Additional context**
Like said, no problem with local builds like with pixi: ` pixi run docs`.
Contributor guide
Research direction
Compare the ReadTheDocs build with the local `pixi run docs` build, focusing on the Sphinx and sphinx-autoapi configuration used by each. Reproduce the empty AutoAPI sections and the file-reading warnings, then verify that the RTD build includes the AutoAPI documentation without those warnings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100