From 8e9ea16eaa66c008ee2800199fbfb0f44241011c Mon Sep 17 00:00:00 2001 From: Manuel-Knepper <148866038+Manuel-Knepper@users.noreply.github.com> Date: Thu, 26 Mar 2026 14:53:27 +0100 Subject: [PATCH 1/9] add workflow for sphinx docs --- .github/workflows/sphinx.yml | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .github/workflows/sphinx.yml diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml new file mode 100644 index 0000000..de30448 --- /dev/null +++ b/.github/workflows/sphinx.yml @@ -0,0 +1,26 @@ +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: 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 From b52d33d422187c582338d6e79062d840b640aa2c Mon Sep 17 00:00:00 2001 From: Manuel-Knepper <148866038+Manuel-Knepper@users.noreply.github.com> Date: Thu, 26 Mar 2026 14:58:39 +0100 Subject: [PATCH 2/9] Fix casing in module name for get_seed_points --- docs/api/GrowBikeNet.functions.get_seed_points.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/GrowBikeNet.functions.get_seed_points.rst b/docs/api/GrowBikeNet.functions.get_seed_points.rst index dfb9f43..b7937c3 100644 --- a/docs/api/GrowBikeNet.functions.get_seed_points.rst +++ b/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 \ No newline at end of file +.. autofunction:: get_seed_points From d36a91fcecfe73ad595fdd1aebcf0fb5a5eae500 Mon Sep 17 00:00:00 2001 From: Manuel-Knepper <148866038+Manuel-Knepper@users.noreply.github.com> Date: Thu, 26 Mar 2026 14:59:25 +0100 Subject: [PATCH 3/9] Fix capitalization in intersects_properly documentation --- docs/api/GrowBikeNet.functions.intersects_properly.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/GrowBikeNet.functions.intersects_properly.rst b/docs/api/GrowBikeNet.functions.intersects_properly.rst index 7ec451e..59951e9 100644 --- a/docs/api/GrowBikeNet.functions.intersects_properly.rst +++ b/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 \ No newline at end of file +.. autofunction:: intersects_properly From 4f974f738f9a3e4ee6e68ee2e5772046608fd9a0 Mon Sep 17 00:00:00 2001 From: Manuel-Knepper <148866038+Manuel-Knepper@users.noreply.github.com> Date: Thu, 26 Mar 2026 14:59:53 +0100 Subject: [PATCH 4/9] Update module name to lowercase in documentation --- docs/api/GrowBikeNet.functions.node_to_edge_attributes.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/GrowBikeNet.functions.node_to_edge_attributes.rst b/docs/api/GrowBikeNet.functions.node_to_edge_attributes.rst index 9247ac4..cf350a1 100644 --- a/docs/api/GrowBikeNet.functions.node_to_edge_attributes.rst +++ b/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 \ No newline at end of file +.. autofunction:: node_to_edge_attributes From 8926c75b6261427a339ffb0dbbee247bdecdb839 Mon Sep 17 00:00:00 2001 From: Manuel-Knepper <148866038+Manuel-Knepper@users.noreply.github.com> Date: Thu, 26 Mar 2026 15:00:19 +0100 Subject: [PATCH 5/9] Update module name to lowercase in documentation --- docs/api/GrowBikeNet.functions.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/GrowBikeNet.functions.rst b/docs/api/GrowBikeNet.functions.rst index 40cd5f7..a1fd82f 100644 --- a/docs/api/GrowBikeNet.functions.rst +++ b/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 - \ No newline at end of file + From db8434f13a5bafaafcba98e9b6da8a01a58bd5d0 Mon Sep 17 00:00:00 2001 From: Manuel-Knepper <148866038+Manuel-Knepper@users.noreply.github.com> Date: Thu, 26 Mar 2026 15:01:20 +0100 Subject: [PATCH 6/9] Fix module name casing in API documentation --- docs/api.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 03e01fe..aa14b82 100644 --- a/docs/api.rst +++ b/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 \ No newline at end of file + functions From 717251c20dafd0695bd2cffc3317fb744dfa2573 Mon Sep 17 00:00:00 2001 From: Manuel-Knepper <148866038+Manuel-Knepper@users.noreply.github.com> Date: Thu, 26 Mar 2026 15:09:11 +0100 Subject: [PATCH 7/9] Comment out growbikenet import in conf.py Comment out the import statement for growbikenet. --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 4eaa325..0cf034c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,7 +15,7 @@ import os import sys -import growbikenet # noqa +#import growbikenet # noqa # sys.path.insert(0, os.path.abspath("../")) version = growbikenet.__version__ @@ -115,4 +115,4 @@ def find_source(): 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}" \ No newline at end of file + return f"https://github.com/BikeNetKit/GrowBikeNet/blob/{tag}/{filename}" From 17675605e84ce23dcdff11835236a9e6783e91eb Mon Sep 17 00:00:00 2001 From: Manuel-Knepper <148866038+Manuel-Knepper@users.noreply.github.com> Date: Thu, 26 Mar 2026 15:11:25 +0100 Subject: [PATCH 8/9] Comment out version and release in conf.py Comment out version and release assignments for growbikenet. --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 0cf034c..d1f7082 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,8 +18,8 @@ #import growbikenet # noqa # sys.path.insert(0, os.path.abspath("../")) -version = growbikenet.__version__ -release = version +#version = growbikenet.__version__ +#release = version # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom From 3ab88ab01bd0f6c05812c54e6c1bef38b90c4f08 Mon Sep 17 00:00:00 2001 From: Manuel-Knepper <148866038+Manuel-Knepper@users.noreply.github.com> Date: Thu, 26 Mar 2026 15:14:54 +0100 Subject: [PATCH 9/9] Disable sphinxcontrib.bibtex extension Comment out sphinxcontrib.bibtex extension in conf.py --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index d1f7082..a3ab86d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,7 +28,7 @@ "sphinx.ext.autodoc", "sphinx.ext.autosummary", "sphinx.ext.linkcode", - "sphinxcontrib.bibtex", + #"sphinxcontrib.bibtex", "sphinx.ext.mathjax", "sphinx.ext.doctest", "sphinx.ext.intersphinx",