docs: reconcile conf.py, index.rst, InlandDenoising export, and README#11
Merged
Conversation
- Add version/release to conf.py via importlib.metadata, remove dead autodoc code - Remove dead api/modules toctree entry (build_docs.sh uses --no-toc) - Add InlandDenoising to _LAZY_ATTRIBUTES so README claim matches API - Fix Python version in README (3.8+, matching pyproject.toml) - Update API ref to canonical maps-lab.github.io/AISdb-lite/
There was a problem hiding this comment.
Pull request overview
This PR reconciles documentation and public API expectations by aligning Sphinx configuration, docs index structure, the aisdb top-level lazy exports, and README statements/links with the package’s actual metadata and intended public surface.
Changes:
- Populate Sphinx
version/releasefrom installed package metadata (with a safe fallback) and remove a dead commented autodoc hook block. - Remove an unused/dead
api/modulestoctree entry from the docs index. - Export
InlandDenoisingvia_LAZY_ATTRIBUTESsoaisdb.InlandDenoisingworks as documented; update README Python version and API reference URL.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Updates minimum Python version to 3.8+ and points API reference to the canonical GitHub Pages URL. |
| docs/source/index.rst | Removes the dead api/modules toctree entry to match the current docs build structure. |
| docs/source/conf.py | Derives version/release from importlib.metadata with fallback; removes dead commented autodoc skip/setup block. |
| aisdb/init.py | Adds InlandDenoising to lazy attribute exports so it’s available as aisdb.InlandDenoising. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
api/modulestoctree entry (build_docs.sh uses--no-toc)InlandDenoisingto_LAZY_ATTRIBUTESsoaisdb.InlandDenoisingworks as README claimsmaps-lab.github.io/AISdb-lite/Files changed
4 files, +11 -16