Skip to content

Add Sphinx autodoc API reference to ReadTheDocs#21

Merged
hechth merged 3 commits into
mainfrom
copilot/extend-readthedocs-api-docs
Mar 25, 2026
Merged

Add Sphinx autodoc API reference to ReadTheDocs#21
hechth merged 3 commits into
mainfrom
copilot/extend-readthedocs-api-docs

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 25, 2026

ReadTheDocs only rendered the README. This adds full API reference docs auto-generated from source docstrings via Sphinx autodoc.

Changes

docs/conf.py

  • Add sys.path setup so autodoc can import the src package
  • Enable sphinx.ext.autodoc, sphinx.ext.napoleon (Google-style docstrings), and sphinx.ext.viewcode
  • Configure autodoc defaults: members, undoc-members, show-inheritance

docs/api/ (new)

  • index.rst — API overview toctree
  • cli.rst, utils.rst, data_sources.rst, reports.rst — per-module autodoc pages; data_sources and reports cover all sub-modules individually

docs/index.md

  • Add toctree entry pointing to api/index

.readthedocs.yaml

  • Install requirements/base.txt in addition to requirements/docs.txt so autodoc can successfully import source modules (pandas, requests, orjson, etc.) during the RTD build
Original prompt

This section details on the original issue you should resolve

<issue_title>Extend readthedocs to also include API documentation via sphinx</issue_title>
<issue_description></issue_description>

Comments on the Issue (you are @copilot in this section)


📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

Copilot AI changed the title [WIP] Add API documentation to Read the Docs using Sphinx Add Sphinx autodoc API reference to ReadTheDocs Mar 25, 2026
Copilot AI requested a review from hechth March 25, 2026 19:54
@hechth hechth marked this pull request as ready for review March 25, 2026 19:55
@hechth hechth merged commit 04e8afa into main Mar 25, 2026
1 check passed
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.

Extend readthedocs to also include API documentation via sphinx

2 participants