Skip to content

Commit 09326bb

Browse files
committed
trying to set up versioning
1 parent 9dec318 commit 09326bb

File tree

2 files changed

+22
-16
lines changed

2 files changed

+22
-16
lines changed

mkdocs.yml

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
site_name: COMPAS Model
2-
site_url: https://github.com/blockresearchgroup/compas_model
2+
site_url: https://github.com/blockresearchgroup/compas_model/
33

4-
repo_url: https://github.com/blockresearchgroup/compas_model
4+
repo_name: blockresearchgroup/compas_model
5+
repo_url: https://github.com/blockresearchgroup/compas_model/
6+
7+
copyright: Copyright © 2024 - 2025, ETH Zurich - Block Research Group
58

69
extra:
710
homepage: https://blockresearchgroup.github.io/compas_model/
11+
version:
12+
provider: mike
813

914
theme:
1015
name: material
@@ -64,7 +69,7 @@ plugins:
6469
default_handler: python
6570
handlers:
6671
python:
67-
paths: [src] # search packages in the src folder
72+
paths: [src] # search packages in the src folder
6873
inventories:
6974
- https://docs.python.org/3/objects.inv
7075
- https://compas.dev/compas/latest/objects.inv
@@ -85,7 +90,7 @@ plugins:
8590
merge_init_into_class: true
8691
modernize_annotations: true
8792
parameter_headings: false
88-
preload_modules: [mkdocstrings,compas]
93+
preload_modules: [mkdocstrings, compas]
8994
relative_crossrefs: true
9095
scoped_crossrefs: true
9196
separate_signature: true
@@ -114,17 +119,17 @@ plugins:
114119
nav:
115120
- Home: index.md
116121
- Get Started:
117-
- Introduction: introduction.md
118-
- Installation: installation.md
122+
- Introduction: introduction.md
123+
- Installation: installation.md
119124
- Reference:
120-
- algorithms: reference/compas_model.algorithms.md
121-
- datastructures: reference/compas_model.datastructures.md
122-
- geometry: reference/compas_model.geometry.md
123-
- interactions: reference/compas_model.interactions.md
124-
- materials: reference/compas_model.materials.md
125-
- models: reference/compas_model.models.md
126-
- modifiers: reference/compas_model.modifiers.md
127-
- scene: reference/compas_model.scene.md
128-
- viewer: reference/compas_model.viewer.md
125+
- algorithms: reference/compas_model.algorithms.md
126+
- datastructures: reference/compas_model.datastructures.md
127+
- geometry: reference/compas_model.geometry.md
128+
- interactions: reference/compas_model.interactions.md
129+
- materials: reference/compas_model.materials.md
130+
- models: reference/compas_model.models.md
131+
- modifiers: reference/compas_model.modifiers.md
132+
- scene: reference/compas_model.scene.md
133+
- viewer: reference/compas_model.viewer.md
129134
- Other:
130-
- changelog.md
135+
- changelog.md

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ dev = [
4242
docs = [
4343
"markdown-callouts >=0.4",
4444
"markdown-exec >=1.8",
45+
"mike",
4546
"mkdocs >=1.6",
4647
"mkdocs-autorefs >=1.4",
4748
"mkdocs-coverage >=1.0",

0 commit comments

Comments
 (0)