From 43ecd33215817ac0dcb41eccafcde8e8dfbefe80 Mon Sep 17 00:00:00 2001 From: Luke Murphy Date: Thu, 1 Aug 2019 13:15:07 +0200 Subject: [PATCH] Fix documentation to render correctly --- documentation/source/code-of-conduct.rst | 5 +++++ documentation/source/conf.py | 1 + documentation/source/contribute.rst | 4 ++++ documentation/source/install.rst | 6 +++--- 4 files changed, 13 insertions(+), 3 deletions(-) diff --git a/documentation/source/code-of-conduct.rst b/documentation/source/code-of-conduct.rst index 2d70708..3f04422 100644 --- a/documentation/source/code-of-conduct.rst +++ b/documentation/source/code-of-conduct.rst @@ -1 +1,6 @@ +.. _code-of-conduct: + +Code of Conduct +*************** + .. include:: ../../CODE_OF_CONDUCT.rst diff --git a/documentation/source/conf.py b/documentation/source/conf.py index 15626ba..68007d8 100644 --- a/documentation/source/conf.py +++ b/documentation/source/conf.py @@ -5,3 +5,4 @@ html_theme = 'alabaster' master_doc = 'index' project = 'merkle-tree-stream' templates_path = ['_templates'] +extensions = ['sphinx.ext.autodoc', 'sphinx_autodoc_typehints'] diff --git a/documentation/source/contribute.rst b/documentation/source/contribute.rst index ac7b6bc..0c99a3e 100644 --- a/documentation/source/contribute.rst +++ b/documentation/source/contribute.rst @@ -1 +1,5 @@ +********** +Contribute +********** + .. include:: ../../CONTRIBUTING.rst diff --git a/documentation/source/install.rst b/documentation/source/install.rst index 6e7e65a..79a9b4a 100644 --- a/documentation/source/install.rst +++ b/documentation/source/install.rst @@ -1,6 +1,6 @@ -************ -Installation -************ +******* +Install +******* .. code-block:: bash