Add docs basics

.github/workflows/docs.yml

@@ -0,0 +1,74 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "bikenetlib/**"
+      - "docs/**"
+      - "logging.cfg"
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  generate-deploy-docs:
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+    name: Generate documentation
+    runs-on: ${{ matrix.os }}
+    env:
+      FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
+    environment:
+      name: Deploy to github pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    defaults:
+      run:
+        shell: bash -el {0}
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v7
+
+      - name: Get week number
+        run: echo "WEEK=$(date +'%V')" >> $GITHUB_ENV
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: mamba-org/setup-micromamba@v3
+        with:
+          create-args: python=${{ matrix.python-version }}
+          environment-file: environment-dev.yml
+          cache-environment: true
+          cache-environment-key: W${{ env.WEEK }}
+
+      - name: Add Notebook Kernel
+        run: python -m ipykernel install --user --name bikenetlib --display-name "Python (bikenetlib)"
+
+      # - name: Generating .rst files
+      #   run: sphinx-apidoc -o docs/api/ bikenetlib/
+      - name: Generating html
+        run: sphinx-build docs/source/ public -b dirhtml
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v6
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v5
+        with:
+          # Upload generated html
+          path: "public/"
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

.gitignore

@@ -2,7 +2,11 @@
 data/
 results/
 cache/
-
+examples/*.gpkg
+/*gpkg
+docs/source/*.gpkg
+docs/source/executed_notebooks/
+docs/jupyter_execute/
 
 # Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode,python,macos,windows
 # Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode,python,macos,windows

README.md

@@ -2,6 +2,7 @@
 
 [![Conda Version](https://img.shields.io/conda/vn/conda-forge/bikenetlib?color=10d249)](https://anaconda.org/conda-forge/bikenetlib)
 [![PyPI Version](https://img.shields.io/pypi/v/bikenetlib?color=10d249)](https://pypi.org/project/BikeNetLib/)
+[![Docs](https://github.com/BikeNetKit/BikeNetLib/actions/workflows/docs.yml/badge.svg)](https://docs.bikenetkit.org/BikeNetLib/)
 [![Test](https://github.com/BikeNetKit/BikeNetLib/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/BikeNetKit/BikeNetLib/actions/workflows/test.yml)
 [![Code coverage](https://codecov.io/gh/BikeNetKit/BikeNetLib/graph/badge.svg)](https://codecov.io/gh/BikeNetKit/BikeNetLib)
 [![Mastodon Follow](https://img.shields.io/mastodon/follow/116693348622375119?domain=https%3A%2F%2Ffosstodon.org)](https://fosstodon.org/@BikeNetKit)
@@ -15,9 +16,9 @@ in the [BikeNetKit family](https://github.com/BikeNetKit), like [GrowBikeNet](ht
 BikeNetLib is imported as `bnl`. There are several building blocks:
 
 - `bnl.io` – Input and output
+- `bnl.osm` – OpenStreetMap constants
 - `bnl.utils` – Utilities
 - `bnl.viz` – Visualization
-- `bnl.osm` – OpenStreetMap constants
 
 BikeNetLib mainly builds on [OSMnx](https://github.com/gboeing/osmnx) and [GeoPandas](https://github.com/geopandas/geopandas).
 
@@ -27,12 +28,18 @@ The recommended way to install BikeNetLib is using [`conda`](https://docs.conda.
 ```
 conda install bikenetlib
 ```
+### Advanced and development installations
+For more installation options, see our [Installation docs](https://docs.bikenetkit.org/BikeNetLib/installation/).
 
 ## Usage
-In development.
+We provide a minimum working example:
+
+- Jupyter notebook ([examples/mwe.ipynb](examples/mwe.ipynb))
+
+For a walkthrough with illustrative examples, see our [Usage docs](https://docs.bikenetkit.org/BikeNetLib/usage/).
 
-## Docs
-In development.
+## Documentation
+Find more information in our docs: [https://docs.bikenetkit.org/BikeNetLib/](https://docs.bikenetkit.org/BikeNetLib/)
 
 ## Supported by
 Development of BikeNetKit/BikeNetLib is supported by the [Innovation Fund Denmark](https://innovationsfonden.dk/en) and the EU HORIZON project [JUST STREETS](https://www.just-streets.eu).

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1 @@
+furo==2025.12.19

docs/source/_static/css/dataframe.css

@@ -0,0 +1,38 @@
+/* Style pandas DataFrame HTML from myst-nb outputs */
+div.cell_output table.dataframe {
+  border: none;
+  border-collapse: collapse;
+  border-spacing: 0;
+  margin: 1em 0;
+  font-size: 0.9em;
+  max-width: 100%;
+  overflow-x: auto;
+  display: block;
+}
+
+div.cell_output table.dataframe thead {
+  border-bottom: 1px solid var(--color-foreground-border);
+}
+
+div.cell_output table.dataframe tr,
+div.cell_output table.dataframe th,
+div.cell_output table.dataframe td {
+  text-align: right;
+  vertical-align: middle;
+  padding: 0.4em 0.6em;
+  line-height: 1.3;
+  border: none;
+  white-space: nowrap;
+}
+
+div.cell_output table.dataframe th {
+  font-weight: 600;
+}
+
+div.cell_output table.dataframe tbody tr:nth-child(odd) {
+  background: color-mix(in srgb, var(--color-background-secondary) 80%, transparent);
+}
+
+div.cell_output table.dataframe tbody tr:hover {
+  background: color-mix(in srgb, var(--color-brand-primary) 12%, transparent);
+}

docs/changelog.md → docs/source/changelog.md

@@ -1,13 +1,16 @@
 # Changelog
 
+
 ## Version 0.7.2 (2026-10-18)
 
 - 🐛 Fixed tqdm import
 
+
 ## Version 0.7.1 (2026-10-17)
 
 - 🐛 Fixed io.silent
 
+
 ## Version 0.7.0 (2026-10-16)
 
 - 📝 Added consolidate.md for an overview of potential functions
@@ -17,6 +20,7 @@
 - 👷 Added test_io
 - ➕ Added tqdm dependency
 
+
 ## Version 0.6.0 (2026-10-10)
 
 - ✨ Added and polished shared utils functions
@@ -27,6 +31,7 @@
 - ⬆️ Updated actions versions
 - ⬆️ Added Python 3.15 support
 
+
 ## Version 0.5.0 (2026-05-22)
 
 - ✨ Initial release ✨