Skip to content

Commit 48e1cc9

Browse files
authored
feat: generate docs with proper label and permalink (#52)
## What's Changed This way we can have all versions in the docs.
1 parent 5c524cc commit 48e1cc9

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

adbc_drivers_validation/generate_documentation.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,14 @@ def render(
255255

256256
output = output_directory / f"{driver}.md"
257257
version = drivers[driver].version
258-
version_header = f":bdg-primary:`Version {version}`"
258+
ref = f"driver-{driver}-{version}"
259+
cross_reference = f"({ref})="
260+
if version.startswith("v") and "dev" not in version:
261+
# An actual release
262+
version_header = f"{{bdg-ref-primary}}`Version {version} <{ref}>` ({{ref}}`permalink to this version <{ref}>`)"
263+
else:
264+
# A prerelease
265+
version_header = f"{{bdg-primary}}`Version {version}`"
259266
if (
260267
version.startswith("unknown")
261268
or version.endswith("-dirty")
@@ -272,6 +279,7 @@ def render(
272279
**template_vars,
273280
"types": types,
274281
"features": features,
282+
"cross_reference": cross_reference,
275283
"version_header": version_header,
276284
},
277285
)

0 commit comments

Comments
 (0)