Skip to content

Refresh Read the Docs and repository landing page - #4

Merged
mtap-research merged 1 commit into
mainfrom
agent/documentation-refresh
Jul 17, 2026
Merged

Refresh Read the Docs and repository landing page#4
mtap-research merged 1 commit into
mainfrom
agent/documentation-refresh

Conversation

@mtap-research

Copy link
Copy Markdown
Collaborator

Summary

  • rewrite the repository README as a task-oriented landing page with module overview, installation paths, reproducibility data, validation, support, citation, and licensing
  • add a source-controlled Sphinx documentation project with installation, module, examples, development, and citation guides
  • add reproducible Read the Docs configuration using Ubuntu 24.04, Python 3.12, and pinned Sphinx dependencies
  • add warning-free documentation builds to the required pull-request gate
  • make repository hygiene require the Read the Docs entry points

Validation

  • python ci/check_repository.py
  • YAML parsing for .readthedocs.yaml and .github/workflows/pr-checks.yml
  • local link target check for README repository-relative links
  • python -m sphinx -W --keep-going -b html docs/source /tmp/aim-docs-html
  • Sphinx 8.2.3 build completed with zero warnings

Notes

The existing generated HTML in docs/ remains untouched for compatibility with the current GitHub Pages site. Read the Docs now builds from the maintainable sources in docs/source/. After merge, the repository still needs to be imported or connected in the Read the Docs dashboard if that external project has not already been configured.

@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: df1cbcc8-114e-4ae2-8d2e-532e3f7c89b1

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/documentation-refresh

Comment @coderabbitai help to get the list of available commands.

@mtap-research
mtap-research marked this pull request as ready for review July 17, 2026 17:08
@mtap-research
mtap-research merged commit 2363334 into main Jul 17, 2026
7 checks 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.

1 participant