Merge pull request #55 from philip-ndikum/read_the_docs

Read the docs

.all-contributorsrc

@@ -0,0 +1,4 @@
+{
+  "projectName": "TemporalScope",
+  "projectOwner": "philip-ndikum"
+}

.gitignore

@@ -30,10 +30,8 @@ share/python-wheels/
 *.egg
 MANIFEST
 
-# Sphinx documentation
-docs/_build/*
-docs/.doctrees/
-docs/.buildinfo
+# Mkdocs documentation
+/site/
 
 # Jupyter / IPython
 .ipynb_checkpoints/

.licenserc.yaml

@@ -22,6 +22,8 @@ header:
     - '**/*.sh'
     - '.gitkeep'
     - '.env.example'
+    - '.all-contributorsrc'
+    - 'scripts/gen_ref_docs.py'
 
   comment: on-failure
 

.readthedocs.yaml

@@ -1,4 +1,4 @@
-# Read the Docs configuration file for Sphinx projects
+# Read the Docs configuration file for Mkdocs projects
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 
 version: 2
@@ -15,6 +15,5 @@ python:
       extra_requirements:
         - docs
 
-sphinx:
-  configuration: docs/conf.py
-  fail_on_warning: true
+mkdocs:
+  configuration: mkdocs.yml