Update README.md with link to documentation

README.md

@@ -5,6 +5,8 @@
 <a href="https://www.pytorchlightning.ai/"><img alt="Code style: black" src="https://img.shields.io/badge/uses-pytorch & pytorch lighting-blueviolet"></a>
 <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code style-black-000000.svg"></a>
 
+> [!TIP]
+> Take a look at our [documentation](https://nsquaredlab.github.io/DocOctopy/README.html).
 
 ## What is this?
 DocOctopy , the **research** library for kinematics, kinetics, and everything else you can think of that has to do with EMG and AIs.

docs/source/conf.py

@@ -33,6 +33,26 @@
 with (HERE.parent.parent / "README.md").open() as f:
     out = f.read()
 
+lines = out.split("\n")
+# find the line_indices containing "[!"
+line_indices = [i for i, line in enumerate(lines) if "[!" in line]
+# find for each index the last line connected to it that does not contain ">".
+lines_connected = {}
+for i, l in enumerate(line_indices):
+    for j in range(l, len(lines) - 1):
+        if ">" in lines[j] and ">" not in lines[j + 1]:
+            lines_connected[l] = j
+            break
+
+for start, end in lines_connected.items():
+    lines[start] = "```{" + lines[start][4:].strip().replace("]", "").lower() + "}\n"
+    for i in range(start + 1, end + 1):
+        lines[i] = lines[i].replace("> ", "") + "\n"
+
+    lines[end] += "```\n"
+
+out = "\n".join(lines)
+
 out = out.split("\n")
 
 # find the index of the line that contains "## What papers/preprints use this package?"