Skip to content

Docs/usage docs #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mszell merged 8 commits into from
Oct 12, 2026
+2,104 −4,031
Merged

Docs/usage docs #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
259aea8
Add footway, reimplement pbi assignment
mszell Oct 12, 2026
a3fd267
Remove clutter
mszell Oct 12, 2026
26aee54
Expose all modules in init and polish it
mszell Oct 12, 2026
c1d6c2d
Update docs with new osm module
mszell Oct 12, 2026
dbe4fdc
Update mwes and get index
mszell Oct 12, 2026
3f79fbf
Fix reset of CRS
mszell Oct 12, 2026
3ff3869
Add Usage 1 docs
mszell Oct 12, 2026
81928a9
Import _reset_auto_settings
mszell Oct 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ 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
Expand Down
795 changes: 0 additions & 795 deletions FixBIkeViz.ipynb
View file
Open in desktop

This file was deleted.

2,311 changes: 0 additions & 2,311 deletions FixBikeMVP.ipynb
View file
Open in desktop

This file was deleted.

641 changes: 0 additions & 641 deletions docs/jupyter_execute/mwe.ipynb
View file
Open in desktop

This file was deleted.

Binary file removed docs/source/_static/logo_eu.png
View file
Open in desktop
Binary file not shown.
Binary file removed docs/source/_static/logo_innovationfund.png
View file
Open in desktop
Binary file not shown.
Binary file removed docs/source/_static/logo_juststreets.png
View file
Open in desktop
Binary file not shown.
18 changes: 9 additions & 9 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,7 @@ To set up FixBikeNet, see the :doc:`installation` page.
To use FixBikeNet, the :doc:`getting_started` page
is a good place to start, which also explains how the package works in detail. For technical documentation, consult the :doc:`reference_user`.

.. Statement of need
.. =================

.. TBA

Source
Origin
------

The source code builds on `the code from the
Expand Down Expand Up @@ -57,12 +52,16 @@ and the EU HORIZON grant JUST STREETS.

|Innovation Fund Denmark|    |European Union|   |JUST STREETS|

.. |Innovation Fund Denmark| image:: _static/logo_innovationfund.png
Developed by |NERDS|

.. |Innovation Fund Denmark| image:: https://raw.githubusercontent.com/BikeNetKit/.github/refs/heads/main/profile/_static/logo_innovationfund.png
:target: https://innovationsfonden.dk/en
.. |European Union| image:: _static/logo_eu.png
.. |European Union| image:: https://raw.githubusercontent.com/BikeNetKit/.github/refs/heads/main/profile/_static/logo_eu.png
:target: https://commission.europa.eu/index_en
.. |JUST STREETS| image:: _static/logo_juststreets.png
.. |JUST STREETS| image:: https://raw.githubusercontent.com/BikeNetKit/.github/refs/heads/main/profile/_static/logo_juststreets.png
:target: https://www.just-streets.eu/
.. |NERDS| image:: https://raw.githubusercontent.com/BikeNetKit/.github/refs/heads/main/profile/_static/logo_nerds.png
:target: https://www.nerds.itu.dk


Documentation contents
Expand All @@ -74,6 +73,7 @@ Documentation contents
Home <self>
installation
getting_started
usage
reference_user
reference_developer
changelog
Loading
Loading