docs(markdown): remove r2m and use recommonmark instead

close #81
pollination · May 29, 2020 · a2608e1 · a2608e1
1 parent 99640ed
commit a2608e1
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 8 deletions.
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -8,7 +8,7 @@ sphinx-bootstrap-theme==0.7.1
 sphinxcontrib-fulltoc==1.2.0
 sphinxcontrib-websupport==1.2.2
 sphinx-click==2.3.2
-m2r==0.2.1
+recommonmark==0.6.0
 twine==3.1.1
 click>=7.0
 click-plugins==1.1.1
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1 @@
+../README.md
diff --git a/docs/conf.py b/docs/conf.py
@@ -50,7 +50,7 @@
 	'sphinxcontrib.fulltoc',
 	'sphinx.ext.napoleon',
     'sphinx_click.ext',
-    'm2r',
+    'recommonmark',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -59,7 +59,11 @@
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-source_suffix = ['.rst', '.md']
+# source_suffix = {
+#     '.rst': 'restructuredtext',
+#     '.md': 'markdown',
+# }
+
 # source_suffix = '.rst'
 
 # The master toctree document.

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,14 +3,17 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+Queenbee
+========
+
+Welcome to Queenbee's Documention site! 
+
+
 .. toctree::
    :maxdepth: 1
-   :hidden:
 
-   welcome
+   README.md
    guides/index
    schemas/index
    cli/index
    modules
-
-.. include:: welcome.rst
diff --git a/docs/welcome.rst b/docs/welcome.rst