configure mkdocs

docs/code/data_model.md

@@ -0,0 +1,2 @@
+# data_model module
+::: rendercv.data_model

docs/code/main.md

@@ -0,0 +1,2 @@
+# __main__ module
+::: rendercv.__main__

docs/code/tinytex.md

@@ -0,0 +1,2 @@
+# tinytex module
+::: rendercv.tinytex

docs/index.md

@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.

mkdocs.yml

@@ -0,0 +1,17 @@
+site_name: My Docs
+theme:
+  name: material
+
+nav:
+  - Home: index.md
+  - About: about.md
+  - Contact: contact.md
+  - License: license.md
+  - Code Reference:
+    - __main__.py: code/main.md
+    - data_model.py: code/data_model.md
+    - tinytex.py: code/tinytex.md
+
+plugins:
+  - search
+  - mkdocstrings

rendercv/__main__.py

@@ -39,7 +39,7 @@ if __name__ == "__main__":
         if link is not None:
             link = link.groups()
             oldLinkString = "[" + link[0] + "](" + link[1] + ")"
-            newLinkString = "\hrefExternal{" + link[1] + "}{" + link[0] + "}"
+            newLinkString = "\\hrefExternal{" + link[1] + "}{" + link[0] + "}"
 
             value = value.replace(oldLinkString, newLinkString)