diff --git a/docs/.pages b/docs/.pages new file mode 100644 index 00000000..b6b722a9 --- /dev/null +++ b/docs/.pages @@ -0,0 +1,5 @@ +nav: + - Home: README.md + - Getting Started: getting_started + - Examples: examples + - ... diff --git a/docs/generate_api.py b/docs/generate_api.py index 0d71d759..5a66b70b 100644 --- a/docs/generate_api.py +++ b/docs/generate_api.py @@ -79,5 +79,5 @@ def _is_camel_case(s: str) -> bool: if i.is_file() and len(i.relative_to(".").parents) <= 3: write_file(i) -with mkdocs_gen_files.open("api/README.md", "a") as nav_file: +with mkdocs_gen_files.open(f"{API_DIRECTORY_PATH}/README.md", "a") as nav_file: nav_file.writelines(nav.build_literate_nav()) diff --git a/examples/embedders/README.md b/examples/embedders/README.md index 6fa3de50..b3b4a665 100644 --- a/examples/embedders/README.md +++ b/examples/embedders/README.md @@ -3,5 +3,6 @@ Examples illustrating the usage of every Joiner. - [CountEmbedder](count_embedder.ipynb) +- [ContextualCountEmbedder](contextual_count_embedder.ipynb) - [GTFS2VecEmbedder](gtfs2vec_embedder.ipynb) - [Highway2VecEmbedder](highway2vec_embedder.ipynb) diff --git a/mkdocs.yml b/mkdocs.yml index 8a43fbab..0766da34 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,12 +9,6 @@ edit_uri: "" watch: - examples -nav: - - Home: README.md - - Getting Started: getting_started - - Examples: examples - - ... | api/** - - ... | full_api/** theme: name: material diff --git a/srai/loaders/__init__.py b/srai/loaders/__init__.py index 757a5895..4963ee38 100644 --- a/srai/loaders/__init__.py +++ b/srai/loaders/__init__.py @@ -9,13 +9,14 @@ from ._base import Loader from .geoparquet_loader import GeoparquetLoader from .gtfs_loader import GTFSLoader -from .osm_loaders import OSMOnlineLoader, OSMPbfLoader +from .osm_loaders import OSMLoader, OSMOnlineLoader, OSMPbfLoader from .osm_way_loader import OSMWayLoader __all__ = [ "Loader", "GeoparquetLoader", "GTFSLoader", + "OSMLoader", "OSMWayLoader", "OSMOnlineLoader", "OSMPbfLoader",