Merge pull request #825 from ethereum/fixDocs

fix Docs
pull/7/head
yann300 7 years ago committed by GitHub
commit 9f99961c63
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 11
      docs/conf.py
  2. 11
      docs/index.rst

@ -20,10 +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.transform import AutoStructify
from recommonmark.parser import CommonMarkParser
source_parsers = {'.md': CommonMarkParser}
# -- General configuration ------------------------------------------------ # -- General configuration ------------------------------------------------
@ -42,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'
@ -293,6 +289,11 @@ 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', {

@ -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
@ -66,4 +56,3 @@ This set of documents covers instructions on how to use Remix and some tutorials
code_contribution_guide code_contribution_guide
support support
support_tab support_tab
Loading…
Cancel
Save