Skip to content

Update docs custom URL #175

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 1 commit into from
Jun 20, 2026
+7 −7
Merged

Update docs custom URL #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Bike Net Kit / Grow Bike Net

[![Docs](https://github.com/BikeNetKit/GrowBikeNet/actions/workflows/docs.yml/badge.svg)](https://bikenetkit.github.io/GrowBikeNet/)
[![Docs](https://github.com/BikeNetKit/GrowBikeNet/actions/workflows/docs.yml/badge.svg)](https://docs.bikenetkit.org/GrowBikeNet/)
[![Test](https://github.com/BikeNetKit/GrowBikeNet/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/BikeNetKit/GrowBikeNet/actions/workflows/test.yml)
[![PyPI - Version](https://img.shields.io/pypi/v/growbikenet)](https://pypi.org/project/growbikenet/)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
Expand All @@ -24,18 +24,18 @@ conda install -c conda-forge growbikenet
```

### Advanced and development installations
For more installation options, see our [Installation docs](https://bikenetkit.github.io/GrowBikeNet/installation/).
For more installation options, see our [Installation docs](https://docs.bikenetkit.org/GrowBikeNet/installation/).

## Usage
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://bikenetkit.github.io/GrowBikeNet/usage/).
For a walkthrough with illustrative examples, see our [Usage docs](https://docs.bikenetkit.org/GrowBikeNet/usage/).

## Docs
Find more information in our docs: [https://bikenetkit.github.io/GrowBikeNet/](https://bikenetkit.github.io/GrowBikeNet/)
Find more information in our docs: [https://docs.bikenetkit.org/GrowBikeNet/](https://docs.bikenetkit.org/GrowBikeNet/)


## Supported by
Expand Down
2 changes: 1 addition & 1 deletion docs/source/mwe.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@
"tags": []
},
"source": [
"See the [Usage docs](https://bikenetkit.github.io/GrowBikeNet/usage/) for detailed explanations."
"See the [Usage docs](https://docs.bikenetkit.org/GrowBikeNet/usage/) for detailed explanations."
]
}
],
Expand Down
2 changes: 1 addition & 1 deletion examples/mwe.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@
"tags": []
},
"source": [
"See the [Usage docs](https://bikenetkit.github.io/GrowBikeNet/usage/) for detailed explanations."
"See the [Usage docs](https://docs.bikenetkit.org/GrowBikeNet/usage/) for detailed explanations."
]
}
],
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ dependencies = [

[project.urls]
Homepage = "https://bikenetkit.org/"
Documentation = "https://bikenetkit.github.io/GrowBikeNet/"
Documentation = "https://docs.bikenetkit.org/GrowBikeNet/"
Repository = "https://github.com/BikeNetKit/GrowBikeNet"
Issues = "https://github.com/BikeNetKit/GrowBikeNet/issues"
Changelog = "https://github.com/BikeNetKit/GrowBikeNet/blob/main/docs/changelog.md"
Expand Down