Updated docs base

README.md

@@ -9,7 +9,7 @@
 <tr>
 
 <td width="20%">
-<img src="docs/images/kompute.jpg">
+<img src="https://raw.githubusercontent.com/axsaucedo/vulkan-kompute/master/docs/images/kompute.jpg">
 </td>
 
 <td>
@@ -154,7 +154,7 @@ Simplified Kompute Components
 <td width=30%>
 
 
-<img width="100%" src="docs/images/kompute-vulkan-architecture.jpg">
+<img width="100%" src="https://raw.githubusercontent.com/axsaucedo/vulkan-kompute/master/docs/images/kompute-vulkan-architecture.jpg">
 
 <br>
 <br>
@@ -166,7 +166,7 @@ Simplified Kompute Components
 
 </td>
 <td>
-<img width="100%" src="docs/images/kompute-architecture.jpg">
+<img width="100%" src="https://raw.githubusercontent.com/axsaucedo/vulkan-kompute/master/docs/images/kompute-architecture.jpg">
 </td>
 </tr>
 </table>

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']
+
+

docs/index.rst

@@ -6,6 +6,8 @@
 Welcome to Vulkan Kompute's documentation!
 ==========================================
 
+.. mdinclude:: ../README.md
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:

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