From a2608e192340d552d893933242a812e0f338202e Mon Sep 17 00:00:00 2001 From: AntoineDao Date: Fri, 29 May 2020 15:57:50 +0100 Subject: [PATCH] docs(markdown): remove r2m and use recommonmark instead close #81 --- dev-requirements.txt | 2 +- docs/README.md | 1 + docs/conf.py | 8 ++++++-- docs/index.rst | 11 +++++++---- docs/welcome.rst | 1 - 5 files changed, 15 insertions(+), 8 deletions(-) create mode 120000 docs/README.md delete mode 100644 docs/welcome.rst diff --git a/dev-requirements.txt b/dev-requirements.txt index 981b294d..de415581 100644 --- 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 \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 120000 index 00000000..32d46ee8 --- /dev/null +++ b/docs/README.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 93588e6c..1d3e3d02 100644 --- 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 index 7c1ade38..d024f498 100644 --- 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 deleted file mode 100644 index e2618b81..00000000 --- a/docs/welcome.rst +++ /dev/null @@ -1 +0,0 @@ -.. mdinclude:: ../README.md \ No newline at end of file