From 5a8112d8d3ed330ca079774eba411f0c12152b16 Mon Sep 17 00:00:00 2001 From: yann300 Date: Thu, 24 May 2018 16:22:31 +0200 Subject: [PATCH] use rst for index --- docs/conf.py | 2 +- docs/index.md | 48 ----------------------------------- docs/index.rst | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 69 insertions(+), 49 deletions(-) delete mode 100644 docs/index.md create mode 100644 docs/index.rst diff --git a/docs/conf.py b/docs/conf.py index b516fa6aeb..9f5b47b41e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,7 +42,7 @@ templates_path = ['_templates'] # You can specify multiple suffix as a list of string: # source_suffix = ['.rst', '.md'] -source_suffix = ['.md'] +source_suffix = ['.rst', '.md'] # The encoding of source files. #source_encoding = 'utf-8-sig' diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 92ccd6a012..0000000000 --- a/docs/index.md +++ /dev/null @@ -1,48 +0,0 @@ -Welcome to Remix documentation! -=============================== - -Remix is a powerful, open source tool that helps you write Solidity contracts straight from the browser. -Written in Javascript, Remix supports both usage in the browser or locally. - -Remix also supports testing, debugging and deploying of smart contracts and much more. - -Our Remix project with all its features is available -at `http://remix.ethereum.org` and more information can be found in these -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 - -* [Solidity Editor](solidity_editor.md) -* [Compile Tab](compile_tab.md) -* [Quick start with JavaScript VM](quickstart_javascript_vm.md) -* [Settings](settings_tab.md) - -## Deploy and test - -* [Run tab](run_tab.md) -* [Interact with contract](udapp.md) - -## Other remix features - -* [File explorer](file_explorer.md) -* [Debugger tab](debugger_tab.md) -* [Analysis tab](analysis_tab.md) -* [Terminal](terminal.md) - -## Tutorials and workshops - -* [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) - -## How to contibute - -* [Contribution guide](code_contribution_guide.md) -* [Support tab](support_tab.md) -* [Support chat](support.md) - diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000000..1647230db8 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,68 @@ +Welcome to Remix documentation! +=============================== + +Remix is a powerful, open source tool that helps you write Solidity contracts straight from the browser. +Written in Javascript, Remix supports both usage in the browser or locally. + +Remix also supports testing, debugging and deploying of smart contracts and much more. + +Our Remix project with all its features is available +at `http://remix.ethereum.org` and more information can be found in these +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 + + solidity_editor + compile_tab + quickstart_javascript_vm + settings_tab + + +.. deploy and test: + +.. toctree:: + :maxdepth: 2 + :caption: Deploy and test + + run_tab + udapp + +.. _other-remix-features: + +.. toctree:: + :maxdepth: 2 + :caption: Other Remix features + + file_explorer + debugger_tab + analysis_tab + terminal + +.. _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 + support_tab \ No newline at end of file