update docs to note 2.0 migration guide

gboeing · Jan 31, 2024 · b321018 · b321018
1 parent 5c27133
commit b321018
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -9,6 +9,8 @@
 
 **OSMnx** is a Python package to easily download, model, analyze, and visualize street networks and other geospatial features from OpenStreetMap. You can download and model walking, driving, or biking networks with a single line of code then analyze and visualize them. You can just as easily work with urban amenities/points of interest, building footprints, transit stops, elevation data, street orientations, speed/travel time, and routing.
 
+OSMnx 2.0 is coming soon: read the [migration guide](https://github.com/gboeing/osmnx/issues/1123).
+
 ## Citation
 
 If you use OSMnx in your work, please cite the journal article:

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,6 +3,10 @@ OSMnx |version|
 
 **OSMnx** is a Python package to easily download, model, analyze, and visualize street networks and other geospatial features from OpenStreetMap. You can download and model walking, driving, or biking networks with a single line of code then analyze and visualize them. You can just as easily work with urban amenities/points of interest, building footprints, transit stops, elevation data, street orientations, speed/travel time, and routing.
 
+OSMnx 2.0 is coming soon: read the `migration guide`_.
+
+.. _migration guide: https://github.com/gboeing/osmnx/issues/1123
+
 Citation
 --------
 

diff --git a/docs/source/user-reference.rst b/docs/source/user-reference.rst
@@ -1,9 +1,11 @@
 User Reference
 ==============
 
-This is the User Reference for the OSMnx package. If you are looking for an introduction to OSMnx, read the :doc:`getting-started` guide.
+This is the User Reference for the OSMnx package. If you are looking for an introduction to OSMnx, read the :doc:`getting-started` guide. This guide describes the usage of OSMnx's public API.
 
-This guide describes the usage of OSMnx's public API. Every function can be accessed via ``ox.module_name.function_name()`` and many can also be accessed directly via ``ox.function_name()`` as a shortcut.
+OSMnx 2.0 is coming soon: read the `migration guide`_.
+
+.. _migration guide: https://github.com/gboeing/osmnx/issues/1123
 
 osmnx.bearing module
 --------------------