Skip to content

Commit 859514b

Browse files
authored
docs(medcat): CU-869avu9pv Fix docs (#180)
* CU-869avu9pv: Add docs link to pyproject.toml * CU-869avu9pv: Try to dynamically set version from tag * CU-869avu9pv: Update the release change in conf
1 parent c35e394 commit 859514b

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

medcat-v2/docs/conf.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,14 @@
2323
author = 'CogStack Org'
2424

2525
# The full version, including alpha/beta/rc tags
26-
release = ':latest' # where is the version retrievable from?
26+
# apprently shoudl be able ot read from env
27+
release = os.getenv("READTHEDOCS_VERSION", ":latest")
28+
29+
# Simplify medcat-v2.3.1rc2 → v2.3.1rc2
30+
# NOTE: in case of tag based releases, the environmental variable
31+
# should contain the sanitised tag as the slug, so the / is
32+
# replaced with the -
33+
release = release.removeprefix("medcat-")
2734

2835

2936
# -- General configuration ---------------------------------------------------

medcat-v2/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ test = [] # TODO - list
127127

128128
[project.urls]
129129
"Homepage" = "https://cogstack.org/"
130+
"Documentation" = "https://docs.cogstack.org/projects/nlp/en/latest/"
130131
"Bug Reports" = "https://discourse.cogstack.org/"
131132
"Source" = "https://github.com/CogStack/cogstack-nlp/"
132133

0 commit comments

Comments
 (0)