Skip to content

docs: reconcile Sphinx config, version strings, and dead toctree entries #189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gabrielspadon merged 1 commit into from
Jul 8, 2026
Merged

docs: reconcile Sphinx config, version strings, and dead toctree entries #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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}
Expand Down
10 changes: 8 additions & 2 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Comment on lines +16 to +19

# -- Project information -----------------------------------------------------

project = "AISDB"
copyright = f"{datetime.today().year}, MAPS Lab"
author = "MAPS Lab"
version = ".".join(_version.split(".")[:2])
release = _version

# -- General configuration ---------------------------------------------------

Expand Down Expand Up @@ -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',
Expand Down
1 change: 0 additions & 1 deletion docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ AISDB Docs: Index

api/aisdb
api/aisdb.*
api/modules

Indices and tables
==================
Expand Down
Loading