diff --git a/docs/conf.py b/docs/conf.py index 9d40a08f53..b516fa6aeb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,13 +15,15 @@ import sys import os -from recommonmark.parser import CommonMarkParser -source_parsers = {'.md': CommonMarkParser} + # 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('.')) +sys.path.insert(0, os.path.abspath('.')) +from recommonmark.parser import CommonMarkParser +from recommonmark.transform import AutoStructify +source_parsers = {'.md': CommonMarkParser} # -- General configuration ------------------------------------------------ @@ -53,6 +55,8 @@ project = u'Remix, Ethereum-IDE' copyright = u'2018, Remix' author = u'Remix team' +github_doc_root = 'https://github.com/ethereum/remix/tree/master/docs/' + # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. @@ -97,7 +101,7 @@ exclude_patterns = ['_build'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' -highlight_language = 'Solidity' +highlight_language = 'JavaScript' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] @@ -288,3 +292,13 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False + +# 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) \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index feb9cf557e..92ccd6a012 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,54 +13,36 @@ 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: +## Quick start -.. toctree:: - :maxdepth: 2 - :caption: Quick start +* [Solidity Editor](solidity_editor.md) +* [Compile Tab](compile_tab.md) +* [Quick start with JavaScript VM](quickstart_javascript_vm.md) +* [Settings](settings_tab.md) - solidity_editor - compile_tab - quickstart_javascript_vm +## Deploy and test +* [Run tab](run_tab.md) +* [Interact with contract](udapp.md) -.. deploy and test: +## Other remix features -.. toctree:: - :maxdepth: 2 - :caption: Deploy and test +* [File explorer](file_explorer.md) +* [Debugger tab](debugger_tab.md) +* [Analysis tab](analysis_tab.md) +* [Terminal](terminal.md) - run_tab - udapp +## Tutorials and workshops -.. _other-remix-features: +* [Workshop building smart contracts](workshop_Building_smart_contracts_with_Remix.md) +* [Use Remix IDE with local files](tutorial_connect_remix_with_your_filesystem.md) +* [How to debug a transaction](tutorial_debug.md) +* [How to import solidity file](tutorial_import.md) +* [How to use Remix IDE in Mist](tutorial_mist.md) -.. toctree:: - :maxdepth: 2 - :caption: Other Remix features +## How to contibute - file_explorer - debugger_tab - analysis_tab - terminal +* [Contribution guide](code_contribution_guide.md) +* [Support tab](support_tab.md) +* [Support chat](support.md) -.. _tutorials and workshops: - -.. toctree:: - :maxdepth: 2 - :caption: Tutorials and workshops - - workshop_Building_smart_contracts_with_Remix - tutorial_connect_remix_with_your_filesystem - tutorial_debug - tutorial_import - tutorial_mist - -.. _code-contribution-guide: - -.. toctree:: - :maxdepth: 2 - :caption: Code contribution guide - - code_contribution_guide - support