DOC: create preprocessing section (#393)

* DOC: create preprocessing section * remove _templates from gitignore * rerun notebook, fix typo * use rediraffe
pysal · Sep 11, 2022 · afcb85b · afcb85b
1 parent b2d8884
commit afcb85b
Show file tree

Hide file tree

Showing 7 changed files with 62 additions and 40 deletions.
diff --git a/.gitignore b/.gitignore
@@ -65,7 +65,6 @@ instance/
 
 # Sphinx documentation
 docs/_build/
-docs/_templates/
 docs/generated/
 
 # PyBuilder

diff --git a/docs/conf.py b/docs/conf.py
@@ -28,7 +28,8 @@
     "pandas",
     "rtree",
     "scipy",
-    "scipy.spatial" "shapely",
+    "scipy.spatial",
+    "shapely",
     "shapely.geometry",
     "shapely.wkt",
     "shapely.ops",
@@ -76,6 +77,7 @@
     "myst_parser",
     "sphinx_copybutton",
     "sphinx_gallery.load_style",
+    "sphinxext.rediraffe",
 ]
 
 # nbsphinx do not use requirejs (breaks bootstrap)
@@ -231,6 +233,11 @@ def setup(app):
 # A list of files that should not be packed into the epub file.
 epub_exclude_files = ["search.html"]
 
+# Add redirect for previously existing pages, each item is like `(from_old, to_new)`
+
+rediraffe_redirects = {
+    "user_guide/elements/preprocessing.ipynb": "user_guide/preprocessing/simple_preprocessing.ipynb",  # noqa
+}
 
 # -- Extension configuration -------------------------------------------------
 # Generate the API documentation when building

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -6,4 +6,5 @@ nbsphinx
 ipython
 myst-parser
 sphinx_copybutton
-sphinx-gallery
+sphinx-gallery
+sphinxext-rediraffe
diff --git a/docs/user_guide/elements/elements.rst b/docs/user_guide/elements/elements.rst
@@ -17,4 +17,3 @@ This section covers:
    enclosed
    blocks
    links
-   preprocessing
diff --git a/docs/user_guide/intro.rst b/docs/user_guide/intro.rst
@@ -25,3 +25,4 @@ Notebooks cover just a small selection of functions as an illustration of princi
    Characters based on multiple GeoDataFrames <combined/combined>
    Using spatial weights matrix <weights/weights>
    Street network analysis <graph/graph>
+   Data preprocessing <preprocessing/preprocessing>
diff --git a/docs/user_guide/preprocessing/preprocessing.rst b/docs/user_guide/preprocessing/preprocessing.rst
@@ -0,0 +1,12 @@
+Generating morphological elements
+=================================
+
+Sometimes we need to preprocess data. `momepy` has a set of tools to edit given geometry
+to make it fit for morphological analysis.
+
+This section covers:
+
+.. toctree::
+   :maxdepth: 2
+
+   simple_preprocessing
diff --git a/docs/user_guide/elements/preprocessing.ipynb → .../preprocessing/simple_preprocessing.ipynb b/docs/user_guide/elements/preprocessing.ipynb → .../preprocessing/simple_preprocessing.ipynb