pull/3094/head
yann300 7 years ago
parent d1295338b2
commit f3acc226bd
  1. 26
      docs/conf.py
  2. 10
      docs/index.rst

@ -20,9 +20,7 @@ import os
# If extensions (or modules to document with autodoc) are in another directory, # 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 # 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. # documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('.')) # sys.path.insert(0, os.path.abspath('.'))
from recommonmark.parser import CommonMarkParser
source_parsers = {'.md': CommonMarkParser}
# -- General configuration ------------------------------------------------ # -- General configuration ------------------------------------------------
@ -41,7 +39,6 @@ templates_path = ['_templates']
# You can specify multiple suffix as a list of string: # You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md'] # source_suffix = ['.rst', '.md']
source_suffix = ['.rst', '.md']
# The encoding of source files. # The encoding of source files.
#source_encoding = 'utf-8-sig' #source_encoding = 'utf-8-sig'
@ -292,12 +289,17 @@ texinfo_documents = [
# If true, do not generate a @detailmenu in the "Top" node's menu. # If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False #texinfo_no_detailmenu = False
from recommonmark.parser import CommonMarkParser
source_suffix = ['.rst', '.md']
source_parsers = {'.md': CommonMarkParser}
# app setup hook # app setup hook
def setup(app): # def setup(app):
app.add_config_value('recommonmark_config', { # app.add_config_value('recommonmark_config', {
'url_resolver': lambda url: github_doc_root + url, # 'url_resolver': lambda url: github_doc_root + url,
'enable_auto_toc_tree': True, # 'enable_auto_toc_tree': True,
'enable_eval_rst': True, # 'enable_eval_rst': True,
'enable_auto_doc_ref': True, # 'enable_auto_doc_ref': True,
}, True) # }, True)
app.add_transform(AutoStructify) # app.add_transform(AutoStructify)

@ -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. This set of documents covers instructions on how to use Remix and some tutorials to help you get started.
.. quick-start:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Quick start :caption: Quick start
@ -25,8 +23,6 @@ This set of documents covers instructions on how to use Remix and some tutorials
settings_tab settings_tab
.. deploy and test:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Deploy and test :caption: Deploy and test
@ -34,8 +30,6 @@ This set of documents covers instructions on how to use Remix and some tutorials
run_tab run_tab
udapp udapp
.. _other-remix-features:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Other Remix features :caption: Other Remix features
@ -45,8 +39,6 @@ This set of documents covers instructions on how to use Remix and some tutorials
analysis_tab analysis_tab
terminal terminal
.. _tutorials and workshops:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Tutorials and workshops :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_import
tutorial_mist tutorial_mist
.. _code-contribution-guide:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Code contribution guide :caption: Code contribution guide

Loading…
Cancel
Save