add workflow for sphinx docs

.github/workflows/sphinx.yml

@@ -0,0 +1,30 @@
+name: "Sphinx: Render docs"
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - name: Install project + docs dependencies
+      run:  |
+        pip install -e .
+        pip install -r docs/requirements.txt
+    - name: Build HTML
+      uses: ammaraskar/sphinx-action@master
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: html-docs
+        path: docs/build/html/
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      if: github.ref == 'refs/heads/main'
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/build/html

docs/api.rst

@@ -1,10 +1,10 @@
 .. _api_ref:
 
-.. automodule:: GrowBikeNet
+.. automodule:: growbikenet
    :members:
    :undoc-members:
 
-.. currentmodule:: GrowBikeNet
+.. currentmodule:: growbikenet
 
 GrowBikeNet API reference
 ==========================
@@ -21,4 +21,4 @@ GrowBikeNet does these things with these functions.
    functions.intersects_properly
    functions.get_seed_points
    functions.node_to_edge_attributes
-   functions
+   functions

docs/api/GrowBikeNet.functions.get_seed_points.rst

@@ -1,6 +1,6 @@
-GrowBikeNet.functions.get\_seed\_points
+growbikenet.functions.get\_seed\_points
 =======================================
 
-.. currentmodule:: GrowBikeNet.functions
+.. currentmodule:: growbikenet.functions
 
-.. autofunction:: get_seed_points
+.. autofunction:: get_seed_points

docs/api/GrowBikeNet.functions.intersects_properly.rst

@@ -1,6 +1,6 @@
-GrowBikeNet.functions.intersects\_properly
+growbikenet.functions.intersects\_properly
 ==========================================
 
-.. currentmodule:: GrowBikeNet.functions
+.. currentmodule:: growbikenet.functions
 
-.. autofunction:: intersects_properly
+.. autofunction:: intersects_properly

docs/api/GrowBikeNet.functions.node_to_edge_attributes.rst

@@ -1,6 +1,6 @@
-GrowBikeNet.functions.node\_to\_edge\_attributes
+growbikenet.functions.node\_to\_edge\_attributes
 ================================================
 
-.. currentmodule:: GrowBikeNet.functions
+.. currentmodule:: growbikenet.functions
 
-.. autofunction:: node_to_edge_attributes
+.. autofunction:: node_to_edge_attributes

docs/api/GrowBikeNet.functions.rst

@@ -1,7 +1,7 @@
-GrowBikeNet.functions
+growbikenet.functions
 =====================
 
-.. automodule:: GrowBikeNet.functions
+.. automodule:: growbikenet.functions
 
 
    .. rubric:: Functions
@@ -30,4 +30,4 @@
       MultiLineString
       Point
       combinations
-
+

docs/conf.py

@@ -14,9 +14,9 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 import os
-import sys
-import growbikenet  # noqa
-# sys.path.insert(0, os.path.abspath("../"))
+import sys  # noqa
+sys.path.insert(0, os.path.abspath(".."))
+import growbikenet
 
 version = growbikenet.__version__
 release = version
@@ -104,15 +104,15 @@ def find_source():
         import os
 
         fn = inspect.getsourcefile(obj)
-        fn = os.path.relpath(fn, start=os.path.dirname(GrowBikeNet.__file__))
+        fn = os.path.relpath(fn, start=os.path.dirname(growbikenet.__file__))
         source, lineno = inspect.getsourcelines(obj)
         return fn, lineno, lineno + len(source) - 1
 
     if domain != "py" or not info["module"]:
         return None
     try:
-        filename = "GrowBikeNet/%s#L%d-L%d" % find_source()  # noqa: UP031
+        filename = "growbikenet/%s#L%d-L%d" % find_source()  # noqa: UP031
     except Exception:
         filename = info["module"].replace(".", "/") + ".py"
     tag = "main" if "+" in release else ("v" + release)
-    return f"https://github.com/BikeNetKit/GrowBikeNet/blob/{tag}/{filename}"
+    return f"https://github.com/BikeNetKit/GrowBikeNet/blob/{tag}/{filename}"

docs/requirements.txt

@@ -1 +1,10 @@
 furo==2021.11.16
+sphinx
+numpydoc
+numpy
+pandas
+geopandas
+networkx
+shapely
+opencv-python
+matplotlib