Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
B
baas-ide
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
JIRA
JIRA
Merge Requests
1
Merge Requests
1
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Registry
Registry
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
guxukai
baas-ide
Commits
59a09fb7
Commit
59a09fb7
authored
May 24, 2018
by
yann300
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
fix index.html in documentation
parent
fd1ddd87
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
42 additions
and
45 deletions
+42
-45
conf.py
docs/conf.py
+19
-4
index.md
docs/index.md
+23
-41
No files found.
docs/conf.py
View file @
59a09fb7
...
@@ -15,13 +15,15 @@
...
@@ -15,13 +15,15 @@
import
sys
import
sys
import
os
import
os
from
recommonmark.parser
import
CommonMarkParser
source_parsers
=
{
'.md'
:
CommonMarkParser
}
# 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
from
recommonmark.transform
import
AutoStructify
source_parsers
=
{
'.md'
:
CommonMarkParser
}
# -- General configuration ------------------------------------------------
# -- General configuration ------------------------------------------------
...
@@ -53,6 +55,8 @@ project = u'Remix, Ethereum-IDE'
...
@@ -53,6 +55,8 @@ project = u'Remix, Ethereum-IDE'
copyright
=
u'2018, Remix'
copyright
=
u'2018, Remix'
author
=
u'Remix team'
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
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# |version| and |release|, also used in various other places throughout the
# built documents.
# built documents.
...
@@ -97,7 +101,7 @@ exclude_patterns = ['_build']
...
@@ -97,7 +101,7 @@ exclude_patterns = ['_build']
# The name of the Pygments (syntax highlighting) style to use.
# The name of the Pygments (syntax highlighting) style to use.
pygments_style
=
'sphinx'
pygments_style
=
'sphinx'
highlight_language
=
'
Solidity
'
highlight_language
=
'
JavaScript
'
# A list of ignored prefixes for module index sorting.
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
#modindex_common_prefix = []
...
@@ -288,3 +292,13 @@ texinfo_documents = [
...
@@ -288,3 +292,13 @@ 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
# 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
docs/index.md
View file @
59a09fb7
...
@@ -13,54 +13,36 @@ docs. Our tool is available at `our GitHub repository
...
@@ -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.
This set of documents covers instructions on how to use Remix and some tutorials to help you get started.
.. quick-start:
## Quick start
.. toctree::
*
[
Solidity Editor
](
solidity_editor.md
)
:maxdepth: 2
*
[
Compile Tab
](
compile_tab.md
)
:caption: Quick start
*
[
Quick start with JavaScript VM
](
quickstart_javascript_vm.md
)
*
[
Settings
](
settings_tab.md
)
solidity_editor
## Deploy and test
compile_tab
quickstart_javascript_vm
*
[
Run tab
](
run_tab.md
)
*
[
Interact with contract
](
udapp.md
)
.. deploy and test:
## Other remix features
.. toctree::
*
[
File explorer
](
file_explorer.md
)
:maxdepth: 2
*
[
Debugger tab
](
debugger_tab.md
)
:caption: Deploy and test
*
[
Analysis tab
](
analysis_tab.md
)
*
[
Terminal
](
terminal.md
)
run_tab
## Tutorials and workshops
udapp
.. _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::
## How to contibute
:maxdepth: 2
:caption: Other Remix features
file_explorer
*
[
Contribution guide
](
code_contribution_guide.md
)
debugger_tab
*
[
Support tab
](
support_tab.md
)
analysis_tab
*
[
Support chat
](
support.md
)
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
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment