diff --git a/README.md b/README.md index 6b446ae5..6440a2ce 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ AIS data comprises digital messages that ships and shore stations broadcast to r The build requires the following. -- Python 3.10 or newer +- Python 3.8 or newer - Rust toolchain via rustup - PostgreSQL with the TimescaleDB and PostGIS extensions @@ -93,7 +93,7 @@ Continuous integration builds wheels for Linux, macOS, and Windows and runs the ## 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-lite/) · [website](https://aisviz.cs.dal.ca/) ## Related projects diff --git a/aisdb/__init__.py b/aisdb/__init__.py index 74314eff..48929b11 100644 --- a/aisdb/__init__.py +++ b/aisdb/__init__.py @@ -66,6 +66,7 @@ "ShoreDist": "aisdb.webdata.shore_dist", "PortDist": "aisdb.webdata.shore_dist", "CoastDist": "aisdb.webdata.shore_dist", + "InlandDenoising": "aisdb.denoising_encoder", "graph": "aisdb.network_graph", "WeatherDataStore": "aisdb.weather.data_store", "Discretizer": "aisdb.discretize.h3", diff --git a/docs/source/conf.py b/docs/source/conf.py index 35037120..02044463 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 = "AISViz" +author = "MAPS Lab" +version = ".".join(_version.split(".")[:2]) +release = _version # -- General configuration --------------------------------------------------- @@ -59,14 +65,3 @@ html_css_files = [ #'custom.css', ] -""" -def skip(app, what, name, obj, would_skip, options): - if "fromFunction" in name: - return True - else: - return would_skip - - -def setup(app): - app.connect("autodoc-skip-member", skip) -""" diff --git a/docs/source/index.rst b/docs/source/index.rst index 132252f5..ecf81dc8 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 ==================