docs: reconcile Sphinx config, version strings, and dead toctree entries#189
Merged
Conversation
- Add version/release to conf.py via importlib.metadata - Fix favicon to use absolute URL instead of fragile relative path - Remove dead api/modules toctree entry (build_docs.sh uses --no-toc) - Align CITATION.cff and README BibTeX version to 1.8.0-alpha (matches git tag) - Update API ref to canonical maps-lab.github.io/AISdb/
There was a problem hiding this comment.
Pull request overview
This PR updates documentation and citation metadata to reduce broken links/toctree entries and to surface versioning information in the rendered Sphinx docs.
Changes:
- Update README documentation links (API reference URL) and adjust the cited version string.
- Remove a dead Sphinx toctree entry (
api/modules) from the docs index. - Update Sphinx
conf.pyto populateversion/releasedynamically and change the configured favicon location. - Align
CITATION.cffversion string with the README BibTeX entry.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| README.md | Updates documentation links and the BibTeX version field. |
| docs/source/index.rst | Removes a dead api/modules toctree entry. |
| docs/source/conf.py | Adds dynamic version/release resolution and changes favicon configuration. |
| CITATION.cff | Updates citation version metadata. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+16
to
+19
| try: | ||
| _version = importlib.metadata.version("aisdb") | ||
| except importlib.metadata.PackageNotFoundError: | ||
| _version = "0.0.0+unknown" |
| # html_static_path = ['.'] | ||
|
|
||
| html_favicon = "../../aisdb_web/map/public/favicon.svg" | ||
| html_favicon = "https://aisviz.cs.dal.ca/favicon.svg" |
| title = {AISdb}, | ||
| year = {2026}, | ||
| version = {1.8.0a0}, | ||
| version = {1.8.0-alpha}, |
| given-names: Gabriel | ||
| affiliation: "MAPS Lab, Dalhousie University" | ||
| version: "1.8.0a0" | ||
| version: "1.8.0-alpha" |
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)1.8.0-alpha(matches git tag)maps-lab.github.io/AISdb/Files changed
4 files, +11 -6