From a409dc1b3e3be430a9dddbe1a00992d25741e5fc Mon Sep 17 00:00:00 2001 From: yann300 Date: Thu, 24 May 2018 16:32:49 +0200 Subject: [PATCH] fix Docs --- docs/conf.py | 26 ++++++++++++++------------ docs/index.rst | 10 ---------- 2 files changed, 14 insertions(+), 22 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index b851b90c2e..4e5b322071 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,9 +20,7 @@ import os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath('.')) -from recommonmark.parser import CommonMarkParser -source_parsers = {'.md': CommonMarkParser} +# sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ @@ -41,7 +39,6 @@ templates_path = ['_templates'] # You can specify multiple suffix as a list of string: # source_suffix = ['.rst', '.md'] -source_suffix = ['.rst', '.md'] # The encoding of source files. #source_encoding = 'utf-8-sig' @@ -292,12 +289,17 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False +from recommonmark.parser import CommonMarkParser +source_suffix = ['.rst', '.md'] +source_parsers = {'.md': CommonMarkParser} + + # app setup hook -def setup(app): - app.add_config_value('recommonmark_config', { - 'url_resolver': lambda url: github_doc_root + url, - 'enable_auto_toc_tree': True, - 'enable_eval_rst': True, - 'enable_auto_doc_ref': True, - }, True) - app.add_transform(AutoStructify) +# def setup(app): +# app.add_config_value('recommonmark_config', { +# 'url_resolver': lambda url: github_doc_root + url, +# 'enable_auto_toc_tree': True, +# 'enable_eval_rst': True, +# 'enable_auto_doc_ref': True, +# }, True) +# app.add_transform(AutoStructify) diff --git a/docs/index.rst b/docs/index.rst index 1647230db8..13594fb830 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,8 +13,6 @@ docs. Our tool is available at `our GitHub repository This set of documents covers instructions on how to use Remix and some tutorials to help you get started. -.. quick-start: - .. toctree:: :maxdepth: 2 :caption: Quick start @@ -25,8 +23,6 @@ This set of documents covers instructions on how to use Remix and some tutorials settings_tab -.. deploy and test: - .. toctree:: :maxdepth: 2 :caption: Deploy and test @@ -34,8 +30,6 @@ This set of documents covers instructions on how to use Remix and some tutorials run_tab udapp -.. _other-remix-features: - .. toctree:: :maxdepth: 2 :caption: Other Remix features @@ -45,8 +39,6 @@ This set of documents covers instructions on how to use Remix and some tutorials analysis_tab terminal -.. _tutorials and workshops: - .. toctree:: :maxdepth: 2 :caption: Tutorials and workshops @@ -57,8 +49,6 @@ This set of documents covers instructions on how to use Remix and some tutorials tutorial_import tutorial_mist -.. _code-contribution-guide: - .. toctree:: :maxdepth: 2 :caption: Code contribution guide