update sphinx

NREL · Nov 8, 2024 · 618d009 · 618d009
1 parent f33b3de
commit 618d009
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 16 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -21,7 +21,7 @@
 author = "National Renewable Energy Laboratory"
 # Initial releases at 0.x.x
 # First stable release at 1.x.x
-full_version = "0.4.1"
+full_version = "0.4.5"
 version = full_version
 # Full version for display in various places.
 release = full_version
@@ -56,7 +56,6 @@
 #
 html_theme = "sphinx_rtd_theme"
 html_theme_options = {
-    "display_version": True,
     "style_external_links": True,
     "style_nav_header_background": "#9B59B6",
 }

diff --git a/docs/source/general/install.rst b/docs/source/general/install.rst
@@ -1,8 +1,16 @@
 Install
 ================== 
 
-From Source (recommended) 
+From PyPI (recommended)
+---------
+
+.. code-block::
+
+  pip install mappymatch 
+
+From Source  
 -------------------------
+
 Clone the repo::
 
    git clone https://github.com/NREL/mappymatch.git && cd mappymatch
@@ -15,12 +23,6 @@ To activate the mappymatch environment::
 
    conda activate mappymatch
 
-From PyPI
----------
-
-.. code-block::
-
-  pip install mappymatch 
 
 .. warning::
 

diff --git a/docs/source/reference/maps.rst b/docs/source/reference/maps.rst
@@ -16,11 +16,6 @@ NxMap
 .. autoclass:: mappymatch.maps.nx.nx_map.NxMap
     :members:
 
-Utility Functions 
-----------------------
-.. autofunction:: mappymatch.maps.nx.nx_map.parse_osmnx_graph 
-.. autofunction:: mappymatch.maps.nx.nx_map.compress
-
 Map interface 
 ------------------- 
 

diff --git a/environment.yml b/environment.yml
@@ -4,7 +4,7 @@ channels:
   - conda-forge
   - defaults
 dependencies:
-  - python=3.10
+  - python=3.12
   - folium
   - geopandas
   - matplotlib

diff --git a/pyproject.toml b/pyproject.toml
@@ -40,7 +40,7 @@ requires-python = ">=3.9"
 # Used to run CI. 
 tests = ["black", "ruff", "mypy>=0.981", "types-requests", "pytest"]
 # Used to build the docs.
-docs = ["sphinx==4.5.0", "sphinx_rtd_theme==1.0.0", "sphinxemoji==0.2.0"]
+docs = ["sphinx>=8.1", "sphinx_rtd_theme>=3.0", "sphinxemoji>=0.3.1"]
 # Tests + docs + other.
 dev = [
   "mappymatch[tests]",