diff --git a/README.md b/README.md
index cddb926e7..523c83c90 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@
-
+
|
@@ -154,7 +154,7 @@ Simplified Kompute Components
|
-
+
@@ -166,7 +166,7 @@ Simplified Kompute Components
|
-
+
|
diff --git a/docs/conf.py b/docs/conf.py
index dcd0dedf5..6b3384139 100755
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -31,8 +31,14 @@ release = '0.1.0'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
- "breathe"
+ # Creates .nojekyll config
+ 'sphinx.ext.githubpages',
+ # Integrates with doxygen
+ "breathe",
+ # Converts markdown to rst
+ "m2r2",
]
+source_suffix = ['.rst', '.md']
# Breathe conf
breathe_default_project = "Kompute"
@@ -74,3 +80,5 @@ if html_theme == 'sphinx_material':
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
+
+
diff --git a/docs/index.rst b/docs/index.rst
index 6e59293cc..7dcb760ed 100755
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,6 +6,8 @@
Welcome to Vulkan Kompute's documentation!
==========================================
+.. mdinclude:: ../README.md
+
.. toctree::
:maxdepth: 2
:caption: Contents:
diff --git a/scripts/requirements.txt b/scripts/requirements.txt
index fefea7ce1..05f33153b 100644
--- a/scripts/requirements.txt
+++ b/scripts/requirements.txt
@@ -7,3 +7,4 @@ quom==1.2.0
Sphinx==3.2.1
sphinx_materialdesign_theme==0.1.11
breathe==4.20.0
+m2r2==0.2.5