From 78f2caff1eba13b12a9de4ec46f9d3e2204b456b Mon Sep 17 00:00:00 2001 From: Gabriel Spadon Date: Wed, 8 Jul 2026 19:13:57 -0400 Subject: [PATCH] docs: reconcile Sphinx config, version strings, and dead toctree entries - 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/ --- CITATION.cff | 2 +- README.md | 4 ++-- docs/source/conf.py | 10 ++++++++-- docs/source/index.rst | 1 - 4 files changed, 11 insertions(+), 6 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index 845718125..da8e966a2 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -6,7 +6,7 @@ authors: - family-names: Spadon given-names: Gabriel affiliation: "MAPS Lab, Dalhousie University" -version: "1.8.0a0" +version: "1.8.0-alpha" date-released: "2026-07-06" url: "https://github.com/MAPS-Lab/AISdb" repository-code: "https://github.com/MAPS-Lab/AISdb" diff --git a/README.md b/README.md index 9d9262bf5..84faf6821 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,7 @@ Bathymetry, distance-to-shore, and distance-to-port rasters used by `aisdb.webda ## Documentation -[docs](https://aisviz.gitbook.io/documentation/) · [tutorials](https://aisviz.gitbook.io/tutorials/) · [API reference](https://aisviz.cs.dal.ca/AISdb/) · [website](https://aisviz.cs.dal.ca/) +[docs](https://aisviz.gitbook.io/documentation/) · [tutorials](https://aisviz.gitbook.io/tutorials/) · [API reference](https://maps-lab.github.io/AISdb/) · [website](https://aisviz.cs.dal.ca/) ## Related projects @@ -105,7 +105,7 @@ If you use AISdb in your work, please cite it. Citation metadata lives in [CITAT author = {Spadon, Gabriel}, title = {AISdb}, year = {2026}, - version = {1.8.0a0}, + version = {1.8.0-alpha}, publisher = {MAPS Lab, Dalhousie University}, url = {https://github.com/MAPS-Lab/AISdb}, license = {AGPL-3.0} diff --git a/docs/source/conf.py b/docs/source/conf.py index bc356c535..5589ab227 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -10,15 +10,21 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # +import importlib.metadata from datetime import datetime -# import aisdb +try: + _version = importlib.metadata.version("aisdb") +except importlib.metadata.PackageNotFoundError: + _version = "0.0.0+unknown" # -- Project information ----------------------------------------------------- project = "AISDB" copyright = f"{datetime.today().year}, MAPS Lab" author = "MAPS Lab" +version = ".".join(_version.split(".")[:2]) +release = _version # -- General configuration --------------------------------------------------- @@ -55,7 +61,7 @@ # html_static_path = ['_static'] # html_static_path = ['.'] -html_favicon = "../../aisdb_web/map/public/favicon.svg" +html_favicon = "https://aisviz.cs.dal.ca/favicon.svg" html_css_files = [ #'custom.css', diff --git a/docs/source/index.rst b/docs/source/index.rst index 132252f5e..ecf81dc83 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -12,7 +12,6 @@ AISDB Docs: Index api/aisdb api/aisdb.* - api/modules Indices and tables ==================