Updated docs base

This commit is contained in:
Alejandro Saucedo 2020-08-28 12:02:33 +01:00
parent eb7f9c93d6
commit 556645f37d
4 changed files with 15 additions and 4 deletions

View file

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

View file

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