From 7a069b7bb65b0b8f5e3ed206a2403596efdf158a Mon Sep 17 00:00:00 2001 From: Michael Szell Date: Tue, 20 Oct 2026 10:18:03 +0200 Subject: [PATCH 1/2] Polish minor docs issues --- README.md | 4 ++-- docs/source/changelog.md | 19 +++++++++++++++++++ docs/source/reference_user.rst | 4 +--- 3 files changed, 22 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9f37a43..b923de3 100644 --- a/README.md +++ b/README.md @@ -46,9 +46,9 @@ We provide a minimum working example in two formats: - Python script ([examples/mwe.py](examples/mwe.py)) - Jupyter notebook ([examples/mwe.ipynb](examples/mwe.ipynb)) -For a walkthrough with illustrative examples, see our [Usage docs](https://docs.bikenetkit.org/GrowBikeNet/usage/). +For a walkthrough with illustrative examples, see our [Usage docs](https://docs.bikenetkit.org/GrowBikeNet/usage/). For a hands-on tutorial, see our [Python tutorials](https://github.com/BikeNetKit/tutorials#python-tutorials). -## Docs +## Documentation Find more information in our docs: [https://docs.bikenetkit.org/GrowBikeNet/](https://docs.bikenetkit.org/GrowBikeNet/) ## Origin diff --git a/docs/source/changelog.md b/docs/source/changelog.md index 0c01ad7..c32a77f 100644 --- a/docs/source/changelog.md +++ b/docs/source/changelog.md @@ -1,8 +1,11 @@ # Changelog + ## Version 0.16.0 (2026-10-19) - ✨ Integrated first functions from BikeNetLib: osm, io, utils +- ➕ Added bikenetlib dependency + ## Version 0.15.0 (2026-10-12) @@ -19,18 +22,22 @@ - 📝 Added OG to docs - 💄 Added whitelisted Stadia maps to docs, replacing broken CartoDB maps + ## Version 0.14.5 (2026-09-24) - 🐛 Added footway to custom filters + ## Version 0.14.4 (2026-09-13) - 🐛 Swapped variant layer in seed point export filename + ## Version 0.14.3 (2026-09-12) - 🐛 Added bicycle_road to pbi mapping + ## Version 0.14.2 (2026-09-11) - 🐛 Fixed reorder bug @@ -40,11 +47,13 @@ - 💄 Made tqdm bars consistent in notebooks - 💄 Polished exported filenames + ## Version 0.14.1 (2026-09-03) - 🐛 Fixed botched bugfix with non-metric CRS - 🐛 Extended PBI config to match custom filters + ## Version 0.14.0 (2026-09-01) - 🐛 Fixed bug with non-metric CRS, now estimating UTM @@ -54,6 +63,7 @@ - ♻️ Refactored main growbikenet flow into functions - 💄 Made tqdm progress bars configurable via constants + ## Version 0.13.1 (2026-08-26) - 🐛 Deleted zero length geometries @@ -64,6 +74,7 @@ - 📝 Added css for docs dataframes and polished docs - 📝 Added usage docs 6 and 7, completing docs + ## Version 0.13.0 (2026-08-14) - 🐛 Changed street network to growable network @@ -78,6 +89,7 @@ - ➕ Added scipy dependency - 📝 Added and polished usage docs + ## Version 0.12.0 (2026-08-05) - ✨ Implemented point and trip data import with weighted growth @@ -91,12 +103,14 @@ - ✅ Removed online tests temporarily - 📝 Fixed docs source variable, added edit button and key navigation + ## Version 0.11.1 (2026-07-17) - 🐛 Fixed validate seed point bug - 🐛 Fixed loading of docs modules - ♻️ Refactored import_files via defaultdict + ## Version 0.11.0 (2026-06-29) - ✨ Implemented bike network import @@ -107,24 +121,28 @@ - 📝 Added changelog to docs - 📝 Deployed docs on new custom URL + ## Version 0.10.3 (2026-06-17) - ➖ Removed unneeded dependencies - 📌 Pinned dependencies consistently - 🔥 Removed video code, temporarily + ## Version 0.10.2 (2026-06-17) - 🐛 Fixed wrong street network definition "all_public", to "drive" - 🐛 Fixed existing bike net not being usable with street net file - 📝 Added more usage docs + ## Version 0.10.1 (2026-06-15) - 🐛 Added missing checks for seed_point_tags - 📝 Added first usage docs - ♻️ Renamed seed_points_file parameter for consistency + ## Version 0.10.0 (2026-06-11) - ✨ Added auto options for seed points @@ -133,6 +151,7 @@ - ✨ Added quadrangulation - 🎨 Renamed variables for better readability + ## Version 0.9.0 (2026-06-09) - ✨ Added import from file for street network and seed points diff --git a/docs/source/reference_user.rst b/docs/source/reference_user.rst index 458a863..0bcf750 100644 --- a/docs/source/reference_user.rst +++ b/docs/source/reference_user.rst @@ -11,12 +11,10 @@ growbikenet.growbikenet .. automodule:: growbikenet.growbikenet :members: - :no-index: growbikenet.settings -------------------- .. automodule:: growbikenet.settings - :members: - :no-index: \ No newline at end of file + :members: \ No newline at end of file From 858161ef2bc6df110b09b8166b962f34f24d6023 Mon Sep 17 00:00:00 2001 From: Michael Szell Date: Tue, 20 Oct 2026 10:19:23 +0200 Subject: [PATCH 2/2] Update checkout actions versions --- .github/workflows/docs.yml | 2 +- .github/workflows/docs_rebuild.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 8519b3d..2514459 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -41,7 +41,7 @@ jobs: shell: bash -el {0} steps: - name: Check out Git repository - uses: actions/checkout@v6 + uses: actions/checkout@v7 - name: Get week number run: echo "WEEK=$(date +'%V')" >> $GITHUB_ENV diff --git a/.github/workflows/docs_rebuild.yml b/.github/workflows/docs_rebuild.yml index 653f47f..7058214 100644 --- a/.github/workflows/docs_rebuild.yml +++ b/.github/workflows/docs_rebuild.yml @@ -33,7 +33,7 @@ jobs: shell: bash -el {0} steps: - name: Check out Git repository - uses: actions/checkout@v6 + uses: actions/checkout@v7 - name: Get week number run: echo "WEEK=$(date +'%V')" >> $GITHUB_ENV