David Disu
4 years ago
committed by
GitHub
commit
3ce30ccb29
@ -0,0 +1,41 @@ |
|||||||
|
{ |
||||||
|
"root": true, |
||||||
|
"parser": "@typescript-eslint/parser", |
||||||
|
"parserOptions": { |
||||||
|
"ecmaVersion": 2018, |
||||||
|
"sourceType": "module", |
||||||
|
"project": "./tsconfig.json" |
||||||
|
}, |
||||||
|
"ignorePatterns": ["**/*"], |
||||||
|
"plugins": ["@typescript-eslint", "@nrwl/nx"], |
||||||
|
"extends": [ |
||||||
|
"eslint:recommended", |
||||||
|
"plugin:@typescript-eslint/eslint-recommended", |
||||||
|
"plugin:@typescript-eslint/recommended", |
||||||
|
"prettier", |
||||||
|
"prettier/@typescript-eslint" |
||||||
|
], |
||||||
|
"rules": { |
||||||
|
"@typescript-eslint/explicit-member-accessibility": "off", |
||||||
|
"@typescript-eslint/explicit-function-return-type": "off", |
||||||
|
"@typescript-eslint/no-parameter-properties": "off", |
||||||
|
"@nrwl/nx/enforce-module-boundaries": [ |
||||||
|
"error", |
||||||
|
{ |
||||||
|
"enforceBuildableLibDependency": true, |
||||||
|
"allow": [], |
||||||
|
"depConstraints": [ |
||||||
|
{ "sourceTag": "*", "onlyDependOnLibsWithTags": ["*"] } |
||||||
|
] |
||||||
|
} |
||||||
|
] |
||||||
|
}, |
||||||
|
"overrides": [ |
||||||
|
{ |
||||||
|
"files": ["*.tsx"], |
||||||
|
"rules": { |
||||||
|
"@typescript-eslint/no-unused-vars": "off" |
||||||
|
} |
||||||
|
} |
||||||
|
] |
||||||
|
} |
||||||
@ -1,3 +0,0 @@ |
|||||||
{ |
|
||||||
"presets": ["@babel/preset-env"] |
|
||||||
} |
|
||||||
@ -0,0 +1,69 @@ |
|||||||
|
.highlight { background: #ffffff; } |
||||||
|
.highlight .c { color: #999988; font-style: italic } /* Comment */ |
||||||
|
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ |
||||||
|
.highlight .k { font-weight: bold } /* Keyword */ |
||||||
|
.highlight .o { font-weight: bold } /* Operator */ |
||||||
|
.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */ |
||||||
|
.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */ |
||||||
|
.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */ |
||||||
|
.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */ |
||||||
|
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ |
||||||
|
.highlight .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */ |
||||||
|
.highlight .ge { font-style: italic } /* Generic.Emph */ |
||||||
|
.highlight .gr { color: #aa0000 } /* Generic.Error */ |
||||||
|
.highlight .gh { color: #999999 } /* Generic.Heading */ |
||||||
|
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ |
||||||
|
.highlight .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */ |
||||||
|
.highlight .go { color: #888888 } /* Generic.Output */ |
||||||
|
.highlight .gp { color: #555555 } /* Generic.Prompt */ |
||||||
|
.highlight .gs { font-weight: bold } /* Generic.Strong */ |
||||||
|
.highlight .gu { color: #800080; font-weight: bold; } /* Generic.Subheading */ |
||||||
|
.highlight .gt { color: #aa0000 } /* Generic.Traceback */ |
||||||
|
.highlight .kc { font-weight: bold } /* Keyword.Constant */ |
||||||
|
.highlight .kd { font-weight: bold } /* Keyword.Declaration */ |
||||||
|
.highlight .kn { font-weight: bold } /* Keyword.Namespace */ |
||||||
|
.highlight .kp { font-weight: bold } /* Keyword.Pseudo */ |
||||||
|
.highlight .kr { font-weight: bold } /* Keyword.Reserved */ |
||||||
|
.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */ |
||||||
|
.highlight .m { color: #009999 } /* Literal.Number */ |
||||||
|
.highlight .s { color: #d14 } /* Literal.String */ |
||||||
|
.highlight .na { color: #008080 } /* Name.Attribute */ |
||||||
|
.highlight .nb { color: #0086B3 } /* Name.Builtin */ |
||||||
|
.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */ |
||||||
|
.highlight .no { color: #008080 } /* Name.Constant */ |
||||||
|
.highlight .ni { color: #800080 } /* Name.Entity */ |
||||||
|
.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */ |
||||||
|
.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */ |
||||||
|
.highlight .nn { color: #555555 } /* Name.Namespace */ |
||||||
|
.highlight .nt { color: #000080 } /* Name.Tag */ |
||||||
|
.highlight .nv { color: #008080 } /* Name.Variable */ |
||||||
|
.highlight .ow { font-weight: bold } /* Operator.Word */ |
||||||
|
.highlight .w { color: #bbbbbb } /* Text.Whitespace */ |
||||||
|
.highlight .mf { color: #009999 } /* Literal.Number.Float */ |
||||||
|
.highlight .mh { color: #009999 } /* Literal.Number.Hex */ |
||||||
|
.highlight .mi { color: #009999 } /* Literal.Number.Integer */ |
||||||
|
.highlight .mo { color: #009999 } /* Literal.Number.Oct */ |
||||||
|
.highlight .sb { color: #d14 } /* Literal.String.Backtick */ |
||||||
|
.highlight .sc { color: #d14 } /* Literal.String.Char */ |
||||||
|
.highlight .sd { color: #d14 } /* Literal.String.Doc */ |
||||||
|
.highlight .s2 { color: #d14 } /* Literal.String.Double */ |
||||||
|
.highlight .se { color: #d14 } /* Literal.String.Escape */ |
||||||
|
.highlight .sh { color: #d14 } /* Literal.String.Heredoc */ |
||||||
|
.highlight .si { color: #d14 } /* Literal.String.Interpol */ |
||||||
|
.highlight .sx { color: #d14 } /* Literal.String.Other */ |
||||||
|
.highlight .sr { color: #009926 } /* Literal.String.Regex */ |
||||||
|
.highlight .s1 { color: #d14 } /* Literal.String.Single */ |
||||||
|
.highlight .ss { color: #990073 } /* Literal.String.Symbol */ |
||||||
|
.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */ |
||||||
|
.highlight .vc { color: #008080 } /* Name.Variable.Class */ |
||||||
|
.highlight .vg { color: #008080 } /* Name.Variable.Global */ |
||||||
|
.highlight .vi { color: #008080 } /* Name.Variable.Instance */ |
||||||
|
.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */ |
||||||
|
|
||||||
|
.type-csharp .highlight .k { color: #0000FF } |
||||||
|
.type-csharp .highlight .kt { color: #0000FF } |
||||||
|
.type-csharp .highlight .nf { color: #000000; font-weight: normal } |
||||||
|
.type-csharp .highlight .nc { color: #2B91AF } |
||||||
|
.type-csharp .highlight .nn { color: #000000 } |
||||||
|
.type-csharp .highlight .s { color: #A31515 } |
||||||
|
.type-csharp .highlight .sc { color: #A31515 } |
||||||
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 434 KiB |
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 19 KiB |
|
After Width: | Height: | Size: 960 B |
|
After Width: | Height: | Size: 423 KiB |
|
After Width: | Height: | Size: 1.4 MiB |
|
After Width: | Height: | Size: 2.6 KiB |
|
After Width: | Height: | Size: 668 B |
|
After Width: | Height: | Size: 3.4 KiB |
|
After Width: | Height: | Size: 12 KiB |
|
After Width: | Height: | Size: 8.3 KiB |
|
After Width: | Height: | Size: 30 KiB |
|
After Width: | Height: | Size: 30 KiB |
|
After Width: | Height: | Size: 3.7 KiB |
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -0,0 +1,93 @@ |
|||||||
|
<!DOCTYPE html> |
||||||
|
|
||||||
|
<html> |
||||||
|
<head> |
||||||
|
<meta charset="utf-8"> |
||||||
|
<!-- |
||||||
|
The MIT License (MIT) |
||||||
|
|
||||||
|
Copyright (c) 2014, 2015, the individual contributors |
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||||
|
of this software and associated documentation files (the "Software"), to deal |
||||||
|
in the Software without restriction, including without limitation the rights |
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||||
|
copies of the Software, and to permit persons to whom the Software is |
||||||
|
furnished to do so, subject to the following conditions: |
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in |
||||||
|
all copies or substantial portions of the Software. |
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
||||||
|
THE SOFTWARE. |
||||||
|
--> |
||||||
|
<meta http-equiv="X-UA-Compatible" content="chrome=1"> |
||||||
|
<title>Remix - Ethereum IDE</title> |
||||||
|
<link rel="stylesheet" href="assets/css/pygment_trac.css"> |
||||||
|
<link rel="icon" type="x-icon" href="icon.png"> |
||||||
|
<script src="assets/js/browserfs.min.js"></script> |
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no"> |
||||||
|
</head> |
||||||
|
<body> |
||||||
|
<script> |
||||||
|
function urlParams () { |
||||||
|
var qs = window.location.hash.substr(1) |
||||||
|
|
||||||
|
if (window.location.search.length > 0) { |
||||||
|
// use legacy query params instead of hash |
||||||
|
window.location.hash = window.location.search.substr(1) |
||||||
|
window.location.search = '' |
||||||
|
} |
||||||
|
|
||||||
|
var params = {} |
||||||
|
var parts = qs.split('&') |
||||||
|
for (var x in parts) { |
||||||
|
var keyValue = parts[x].split('=') |
||||||
|
if (keyValue[0] !== '') { |
||||||
|
params[keyValue[0]] = keyValue[1] |
||||||
|
} |
||||||
|
} |
||||||
|
return params |
||||||
|
} |
||||||
|
const defaultVersion = '0.8.0' |
||||||
|
let versionToLoad = urlParams().appVersion ? urlParams().appVersion : defaultVersion |
||||||
|
|
||||||
|
let assets = { |
||||||
|
'0.8.0': ['https://use.fontawesome.com/releases/v5.8.1/css/all.css', 'assets/css/pygment_trac.css'], |
||||||
|
'0.7.7': ['assets/css/font-awesome.min.css', 'assets/css/pygment_trac.css'] |
||||||
|
} |
||||||
|
let versions = { |
||||||
|
'0.7.7': 'assets/js/0.7.7/app.js', // commit 7b5c7ae3de935e0ccc32eadfd83bf7349478491e |
||||||
|
'0.8.0': 'main.js' |
||||||
|
} |
||||||
|
for (let k in assets[versionToLoad]) { |
||||||
|
let app = document.createElement('link') |
||||||
|
app.setAttribute('rel', 'stylesheet') |
||||||
|
app.setAttribute('href', assets[versionToLoad][k]) |
||||||
|
if (assets[versionToLoad][k] === 'https://use.fontawesome.com/releases/v5.8.1/css/all.css') { |
||||||
|
app.setAttribute('integrity', 'sha384-50oBUHEmvpQ+1lW4y57PTFmhCaXp0ML5d60M1M7uH2+nqUivzIebhndOJK28anvf') |
||||||
|
app.setAttribute('crossorigin', 'anonymous') |
||||||
|
} |
||||||
|
document.head.appendChild(app) |
||||||
|
} |
||||||
|
window.onload = () => { |
||||||
|
BrowserFS.install(window) |
||||||
|
BrowserFS.configure({ |
||||||
|
fs: "LocalStorage" |
||||||
|
}, function(e) { |
||||||
|
if (e) console.log(e) |
||||||
|
let app = document.createElement('script') |
||||||
|
app.setAttribute('src', versions[versionToLoad]) |
||||||
|
document.body.appendChild(app) |
||||||
|
window.remixFileSystem = require('fs') |
||||||
|
}) |
||||||
|
} |
||||||
|
</script> |
||||||
|
<script src="runtime.js" type="module"></script><script src="polyfills.js" type="module"></script><script src="styles.js" type="module"></script><script src="vendor.js" type="module"></script> |
||||||
|
</body> |
||||||
|
</html> |
||||||
@ -0,0 +1 @@ |
|||||||
|
import './index' |
||||||
@ -0,0 +1,7 @@ |
|||||||
|
/** |
||||||
|
* Polyfill stable language features. These imports will be optimized by `@babel/preset-env`. |
||||||
|
* |
||||||
|
* See: https://github.com/zloirock/core-js#babel
|
||||||
|
*/ |
||||||
|
import 'core-js/stable'; |
||||||
|
import 'regenerator-runtime/runtime'; |
||||||
@ -0,0 +1,92 @@ |
|||||||
|
<!DOCTYPE html> |
||||||
|
|
||||||
|
<html> |
||||||
|
<head> |
||||||
|
<meta charset="utf-8"> |
||||||
|
<!-- |
||||||
|
The MIT License (MIT) |
||||||
|
|
||||||
|
Copyright (c) 2014, 2015, the individual contributors |
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||||
|
of this software and associated documentation files (the "Software"), to deal |
||||||
|
in the Software without restriction, including without limitation the rights |
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||||
|
copies of the Software, and to permit persons to whom the Software is |
||||||
|
furnished to do so, subject to the following conditions: |
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in |
||||||
|
all copies or substantial portions of the Software. |
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
||||||
|
THE SOFTWARE. |
||||||
|
--> |
||||||
|
<meta http-equiv="X-UA-Compatible" content="chrome=1"> |
||||||
|
<title>Remix - Ethereum IDE</title> |
||||||
|
<link rel="stylesheet" href="assets/css/pygment_trac.css"> |
||||||
|
<link rel="icon" type="x-icon" href="icon.png"> |
||||||
|
<script src="assets/js/browserfs.min.js"></script> |
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no"> |
||||||
|
</head> |
||||||
|
<body> |
||||||
|
<script> |
||||||
|
function urlParams () { |
||||||
|
var qs = window.location.hash.substr(1) |
||||||
|
|
||||||
|
if (window.location.search.length > 0) { |
||||||
|
// use legacy query params instead of hash |
||||||
|
window.location.hash = window.location.search.substr(1) |
||||||
|
window.location.search = '' |
||||||
|
} |
||||||
|
|
||||||
|
var params = {} |
||||||
|
var parts = qs.split('&') |
||||||
|
for (var x in parts) { |
||||||
|
var keyValue = parts[x].split('=') |
||||||
|
if (keyValue[0] !== '') { |
||||||
|
params[keyValue[0]] = keyValue[1] |
||||||
|
} |
||||||
|
} |
||||||
|
return params |
||||||
|
} |
||||||
|
const defaultVersion = '0.8.0' |
||||||
|
let versionToLoad = urlParams().appVersion ? urlParams().appVersion : defaultVersion |
||||||
|
|
||||||
|
let assets = { |
||||||
|
'0.8.0': ['https://use.fontawesome.com/releases/v5.8.1/css/all.css', 'assets/css/pygment_trac.css'], |
||||||
|
'0.7.7': ['assets/css/font-awesome.min.css', 'assets/css/pygment_trac.css'] |
||||||
|
} |
||||||
|
let versions = { |
||||||
|
'0.7.7': 'assets/js/0.7.7/app.js', // commit 7b5c7ae3de935e0ccc32eadfd83bf7349478491e |
||||||
|
'0.8.0': 'main.js' |
||||||
|
} |
||||||
|
for (let k in assets[versionToLoad]) { |
||||||
|
let app = document.createElement('link') |
||||||
|
app.setAttribute('rel', 'stylesheet') |
||||||
|
app.setAttribute('href', assets[versionToLoad][k]) |
||||||
|
if (assets[versionToLoad][k] === 'https://use.fontawesome.com/releases/v5.8.1/css/all.css') { |
||||||
|
app.setAttribute('integrity', 'sha384-50oBUHEmvpQ+1lW4y57PTFmhCaXp0ML5d60M1M7uH2+nqUivzIebhndOJK28anvf') |
||||||
|
app.setAttribute('crossorigin', 'anonymous') |
||||||
|
} |
||||||
|
document.head.appendChild(app) |
||||||
|
} |
||||||
|
window.onload = () => { |
||||||
|
BrowserFS.install(window) |
||||||
|
BrowserFS.configure({ |
||||||
|
fs: "LocalStorage" |
||||||
|
}, function(e) { |
||||||
|
if (e) console.log(e) |
||||||
|
let app = document.createElement('script') |
||||||
|
app.setAttribute('src', versions[versionToLoad]) |
||||||
|
document.body.appendChild(app) |
||||||
|
window.remixFileSystem = require('fs') |
||||||
|
}) |
||||||
|
} |
||||||
|
</script> |
||||||
|
</body> |
||||||
|
</html> |
||||||
@ -0,0 +1,9 @@ |
|||||||
|
{ |
||||||
|
"extends": "./tsconfig.json", |
||||||
|
"compilerOptions": { |
||||||
|
"outDir": "../../dist/out-tsc", |
||||||
|
"types": ["node"] |
||||||
|
}, |
||||||
|
"exclude": ["**/*.spec.ts", "**/*.spec.tsx"], |
||||||
|
"include": ["**/*.js", "**/*.jsx", "**/*.ts", "**/*.tsx"] |
||||||
|
} |
||||||
@ -0,0 +1,15 @@ |
|||||||
|
{ |
||||||
|
"extends": "../../tsconfig.json", |
||||||
|
"compilerOptions": { |
||||||
|
"jsx": "react", |
||||||
|
"allowJs": true, |
||||||
|
"esModuleInterop": true, |
||||||
|
"allowSyntheticDefaultImports": true, |
||||||
|
"types": ["node", "jest"] |
||||||
|
}, |
||||||
|
"files": [ |
||||||
|
"../../node_modules/@nrwl/react/typings/cssmodule.d.ts", |
||||||
|
"../../node_modules/@nrwl/react/typings/image.d.ts" |
||||||
|
], |
||||||
|
"include": ["**/*.js", "**/*.jsx", "**/*.ts", "**/*.tsx"] |
||||||
|
} |
||||||
@ -0,0 +1,15 @@ |
|||||||
|
{ |
||||||
|
"extends": "./tsconfig.json", |
||||||
|
"compilerOptions": { |
||||||
|
"outDir": "../../dist/out-tsc", |
||||||
|
"module": "commonjs", |
||||||
|
"types": ["jest", "node"] |
||||||
|
}, |
||||||
|
"include": [ |
||||||
|
"**/*.spec.ts", |
||||||
|
"**/*.spec.tsx", |
||||||
|
"**/*.spec.js", |
||||||
|
"**/*.spec.jsx", |
||||||
|
"**/*.d.ts" |
||||||
|
] |
||||||
|
} |
||||||
@ -0,0 +1,17 @@ |
|||||||
|
const nxWebpack = require('@nrwl/react/plugins/webpack') |
||||||
|
|
||||||
|
module.exports = config => { |
||||||
|
const nxWebpackConfig = nxWebpack(config) |
||||||
|
|
||||||
|
return { |
||||||
|
...nxWebpackConfig, |
||||||
|
node: { |
||||||
|
fs: 'empty', |
||||||
|
tls: 'empty', |
||||||
|
readline: 'empty', |
||||||
|
net: 'empty', |
||||||
|
module: 'empty', |
||||||
|
child_process: 'empty' |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
@ -0,0 +1,3 @@ |
|||||||
|
module.exports = { |
||||||
|
"plugins": ["@babel/plugin-transform-modules-commonjs"] |
||||||
|
} |
||||||
@ -0,0 +1,9 @@ |
|||||||
|
module.exports = { |
||||||
|
testMatch: ['**/+(*.)+(spec|test).+(ts|js)?(x)'], |
||||||
|
transform: { |
||||||
|
'^.+\\.(ts|js|html)$': 'ts-jest' |
||||||
|
}, |
||||||
|
resolver: '@nrwl/jest/plugins/resolver', |
||||||
|
moduleFileExtensions: ['ts', 'js', 'html'], |
||||||
|
coverageReporters: ['html'] |
||||||
|
}; |
||||||
@ -1,216 +0,0 @@ |
|||||||
# Makefile for Sphinx documentation
|
|
||||||
#
|
|
||||||
|
|
||||||
# You can set these variables from the command line.
|
|
||||||
SPHINXOPTS =
|
|
||||||
SPHINXBUILD = sphinx-build
|
|
||||||
PAPER =
|
|
||||||
BUILDDIR = _build
|
|
||||||
|
|
||||||
# User-friendly check for sphinx-build
|
|
||||||
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) |
|
||||||
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) |
|
||||||
endif |
|
||||||
|
|
||||||
# Internal variables.
|
|
||||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
|
||||||
PAPEROPT_letter = -D latex_paper_size=letter
|
|
||||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
|
||||||
# the i18n builder cannot share the environment and doctrees with the others
|
|
||||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
|
||||||
|
|
||||||
.PHONY: help |
|
||||||
help: |
|
||||||
@echo "Please use \`make <target>' where <target> is one of"
|
|
||||||
@echo " html to make standalone HTML files"
|
|
||||||
@echo " dirhtml to make HTML files named index.html in directories"
|
|
||||||
@echo " singlehtml to make a single large HTML file"
|
|
||||||
@echo " pickle to make pickle files"
|
|
||||||
@echo " json to make JSON files"
|
|
||||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
|
||||||
@echo " qthelp to make HTML files and a qthelp project"
|
|
||||||
@echo " applehelp to make an Apple Help Book"
|
|
||||||
@echo " devhelp to make HTML files and a Devhelp project"
|
|
||||||
@echo " epub to make an epub"
|
|
||||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
|
||||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
|
||||||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
|
||||||
@echo " text to make text files"
|
|
||||||
@echo " man to make manual pages"
|
|
||||||
@echo " texinfo to make Texinfo files"
|
|
||||||
@echo " info to make Texinfo files and run them through makeinfo"
|
|
||||||
@echo " gettext to make PO message catalogs"
|
|
||||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
|
||||||
@echo " xml to make Docutils-native XML files"
|
|
||||||
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
|
||||||
@echo " linkcheck to check all external links for integrity"
|
|
||||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
|
||||||
@echo " coverage to run coverage check of the documentation (if enabled)"
|
|
||||||
|
|
||||||
.PHONY: clean |
|
||||||
clean: |
|
||||||
rm -rf $(BUILDDIR)/*
|
|
||||||
|
|
||||||
.PHONY: html |
|
||||||
html: |
|
||||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
|
||||||
|
|
||||||
.PHONY: dirhtml |
|
||||||
dirhtml: |
|
||||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
|
||||||
|
|
||||||
.PHONY: singlehtml |
|
||||||
singlehtml: |
|
||||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
|
||||||
|
|
||||||
.PHONY: pickle |
|
||||||
pickle: |
|
||||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
|
||||||
@echo
|
|
||||||
@echo "Build finished; now you can process the pickle files."
|
|
||||||
|
|
||||||
.PHONY: json |
|
||||||
json: |
|
||||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
|
||||||
@echo
|
|
||||||
@echo "Build finished; now you can process the JSON files."
|
|
||||||
|
|
||||||
.PHONY: htmlhelp |
|
||||||
htmlhelp: |
|
||||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
|
||||||
@echo
|
|
||||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
|
||||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
|
||||||
|
|
||||||
.PHONY: qthelp |
|
||||||
qthelp: |
|
||||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
|
||||||
@echo
|
|
||||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
|
||||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
|
||||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Remix.qhcp"
|
|
||||||
@echo "To view the help file:"
|
|
||||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Remix.qhc"
|
|
||||||
|
|
||||||
.PHONY: applehelp |
|
||||||
applehelp: |
|
||||||
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
|
|
||||||
@echo "N.B. You won't be able to view it unless you put it in" \
|
|
||||||
"~/Library/Documentation/Help or install it in your application" \
|
|
||||||
"bundle."
|
|
||||||
|
|
||||||
.PHONY: devhelp |
|
||||||
devhelp: |
|
||||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
|
||||||
@echo
|
|
||||||
@echo "Build finished."
|
|
||||||
@echo "To view the help file:"
|
|
||||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/Remix"
|
|
||||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Remix"
|
|
||||||
@echo "# devhelp"
|
|
||||||
|
|
||||||
.PHONY: epub |
|
||||||
epub: |
|
||||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
|
||||||
|
|
||||||
.PHONY: latex |
|
||||||
latex: |
|
||||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
||||||
@echo
|
|
||||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
|
||||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
|
||||||
"(use \`make latexpdf' here to do that automatically)."
|
|
||||||
|
|
||||||
.PHONY: latexpdf |
|
||||||
latexpdf: |
|
||||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
||||||
@echo "Running LaTeX files through pdflatex..."
|
|
||||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
|
||||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
|
||||||
|
|
||||||
.PHONY: latexpdfja |
|
||||||
latexpdfja: |
|
||||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
||||||
@echo "Running LaTeX files through platex and dvipdfmx..."
|
|
||||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
|
||||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
|
||||||
|
|
||||||
.PHONY: text |
|
||||||
text: |
|
||||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
|
||||||
|
|
||||||
.PHONY: man |
|
||||||
man: |
|
||||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
|
||||||
|
|
||||||
.PHONY: texinfo |
|
||||||
texinfo: |
|
||||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
|
||||||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
|
||||||
"(use \`make info' here to do that automatically)."
|
|
||||||
|
|
||||||
.PHONY: info |
|
||||||
info: |
|
||||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
|
||||||
@echo "Running Texinfo files through makeinfo..."
|
|
||||||
make -C $(BUILDDIR)/texinfo info
|
|
||||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
|
||||||
|
|
||||||
.PHONY: gettext |
|
||||||
gettext: |
|
||||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
|
||||||
|
|
||||||
.PHONY: changes |
|
||||||
changes: |
|
||||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
|
||||||
@echo
|
|
||||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
|
||||||
|
|
||||||
.PHONY: linkcheck |
|
||||||
linkcheck: |
|
||||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
|
||||||
@echo
|
|
||||||
@echo "Link check complete; look for any errors in the above output " \
|
|
||||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
|
||||||
|
|
||||||
.PHONY: doctest |
|
||||||
doctest: |
|
||||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
|
||||||
@echo "Testing of doctests in the sources finished, look at the " \
|
|
||||||
"results in $(BUILDDIR)/doctest/output.txt."
|
|
||||||
|
|
||||||
.PHONY: coverage |
|
||||||
coverage: |
|
||||||
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
|
|
||||||
@echo "Testing of coverage in the sources finished, look at the " \
|
|
||||||
"results in $(BUILDDIR)/coverage/python.txt."
|
|
||||||
|
|
||||||
.PHONY: xml |
|
||||||
xml: |
|
||||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
|
||||||
|
|
||||||
.PHONY: pseudoxml |
|
||||||
pseudoxml: |
|
||||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
|
||||||
@ -1,305 +0,0 @@ |
|||||||
# -*- coding: utf-8 -*- |
|
||||||
# |
|
||||||
# Remix documentation build configuration file, created by |
|
||||||
# sphinx-quickstart on Mon Feb 20 12:16:16 2017. |
|
||||||
# |
|
||||||
# This file is execfile()d with the current directory set to its |
|
||||||
# containing dir. |
|
||||||
# |
|
||||||
# Note that not all possible configuration values are present in this |
|
||||||
# autogenerated file. |
|
||||||
# |
|
||||||
# All configuration values have a default; values that are commented out |
|
||||||
# serve to show the default. |
|
||||||
|
|
||||||
import sys |
|
||||||
import os |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# 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('.')) |
|
||||||
|
|
||||||
# -- General configuration ------------------------------------------------ |
|
||||||
|
|
||||||
# If your documentation needs a minimal Sphinx version, state it here. |
|
||||||
#needs_sphinx = '1.0' |
|
||||||
|
|
||||||
# Add any Sphinx extension module names here, as strings. They can be |
|
||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
|
||||||
# ones. |
|
||||||
extensions = [] |
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory. |
|
||||||
templates_path = ['_templates'] |
|
||||||
|
|
||||||
# The suffix(es) of source filenames. |
|
||||||
# You can specify multiple suffix as a list of string: |
|
||||||
# source_suffix = ['.rst', '.md'] |
|
||||||
|
|
||||||
|
|
||||||
# The encoding of source files. |
|
||||||
#source_encoding = 'utf-8-sig' |
|
||||||
|
|
||||||
# The master toctree document. |
|
||||||
master_doc = 'index' |
|
||||||
|
|
||||||
# General information about the project. |
|
||||||
project = u'Remix, Ethereum-IDE' |
|
||||||
copyright = u'2019, Remix' |
|
||||||
author = u'Remix team' |
|
||||||
|
|
||||||
github_doc_root = 'https://github.com/ethereum/remix-ide/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. |
|
||||||
# |
|
||||||
# The short X.Y version. |
|
||||||
version = u'1' |
|
||||||
# The full version, including alpha/beta/rc tags. |
|
||||||
release = u'1' |
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation |
|
||||||
# for a list of supported languages. |
|
||||||
# |
|
||||||
# This is also used if you do content translation via gettext catalogs. |
|
||||||
# Usually you set "language" from the command line for these cases. |
|
||||||
language = None |
|
||||||
|
|
||||||
# There are two options for replacing |today|: either, you set today to some |
|
||||||
# non-false value, then it is used: |
|
||||||
#today = '' |
|
||||||
# Else, today_fmt is used as the format for a strftime call. |
|
||||||
#today_fmt = '%B %d, %Y' |
|
||||||
|
|
||||||
# List of patterns, relative to source directory, that match files and |
|
||||||
# directories to ignore when looking for source files. |
|
||||||
exclude_patterns = ['_build'] |
|
||||||
|
|
||||||
# The reST default role (used for this markup: `text`) to use for all |
|
||||||
# documents. |
|
||||||
#default_role = None |
|
||||||
|
|
||||||
# If true, '()' will be appended to :func: etc. cross-reference text. |
|
||||||
#add_function_parentheses = True |
|
||||||
|
|
||||||
# If true, the current module name will be prepended to all description |
|
||||||
# unit titles (such as .. function::). |
|
||||||
#add_module_names = True |
|
||||||
|
|
||||||
# If true, sectionauthor and moduleauthor directives will be shown in the |
|
||||||
# output. They are ignored by default. |
|
||||||
#show_authors = False |
|
||||||
|
|
||||||
# The name of the Pygments (syntax highlighting) style to use. |
|
||||||
pygments_style = 'sphinx' |
|
||||||
|
|
||||||
highlight_language = 'JavaScript' |
|
||||||
|
|
||||||
# A list of ignored prefixes for module index sorting. |
|
||||||
#modindex_common_prefix = [] |
|
||||||
|
|
||||||
# If true, keep warnings as "system message" paragraphs in the built documents. |
|
||||||
#keep_warnings = False |
|
||||||
|
|
||||||
# If true, `todo` and `todoList` produce output, else they produce nothing. |
|
||||||
todo_include_todos = False |
|
||||||
|
|
||||||
|
|
||||||
# -- Options for HTML output ---------------------------------------------- |
|
||||||
|
|
||||||
# The theme to use for HTML and HTML Help pages. See the documentation for |
|
||||||
# a list of builtin themes. |
|
||||||
html_theme = 'sphinx_rtd_theme' |
|
||||||
|
|
||||||
|
|
||||||
# Theme options are theme-specific and customize the look and feel of a theme |
|
||||||
# further. For a list of options available for each theme, see the |
|
||||||
# documentation. |
|
||||||
#html_theme_options = {} |
|
||||||
|
|
||||||
# Add any paths that contain custom themes here, relative to this directory. |
|
||||||
#html_theme_path = [] |
|
||||||
|
|
||||||
# The name for this set of Sphinx documents. If None, it defaults to |
|
||||||
# "<project> v<release> documentation". |
|
||||||
#html_title = None |
|
||||||
|
|
||||||
# A shorter title for the navigation bar. Default is the same as html_title. |
|
||||||
#html_short_title = None |
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top |
|
||||||
# of the sidebar. |
|
||||||
#html_logo = None |
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to use as a favicon of |
|
||||||
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
|
||||||
# pixels large. |
|
||||||
#html_favicon = None |
|
||||||
|
|
||||||
# Add any paths that contain custom static files (such as style sheets) here, |
|
||||||
# relative to this directory. They are copied after the builtin static files, |
|
||||||
# so a file named "default.css" will overwrite the builtin "default.css". |
|
||||||
html_static_path = ['_static'] |
|
||||||
|
|
||||||
# Add any extra paths that contain custom files (such as robots.txt or |
|
||||||
# .htaccess) here, relative to this directory. These files are copied |
|
||||||
# directly to the root of the documentation. |
|
||||||
#html_extra_path = [] |
|
||||||
|
|
||||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
|
||||||
# using the given strftime format. |
|
||||||
#html_last_updated_fmt = '%b %d, %Y' |
|
||||||
|
|
||||||
# If true, SmartyPants will be used to convert quotes and dashes to |
|
||||||
# typographically correct entities. |
|
||||||
#html_use_smartypants = True |
|
||||||
|
|
||||||
# Custom sidebar templates, maps document names to template names. |
|
||||||
#html_sidebars = {} |
|
||||||
|
|
||||||
# Additional templates that should be rendered to pages, maps page names to |
|
||||||
# template names. |
|
||||||
#html_additional_pages = {} |
|
||||||
|
|
||||||
# If false, no module index is generated. |
|
||||||
#html_domain_indices = True |
|
||||||
|
|
||||||
# If false, no index is generated. |
|
||||||
#html_use_index = True |
|
||||||
|
|
||||||
# If true, the index is split into individual pages for each letter. |
|
||||||
#html_split_index = False |
|
||||||
|
|
||||||
# If true, links to the reST sources are added to the pages. |
|
||||||
#html_show_sourcelink = True |
|
||||||
|
|
||||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
|
||||||
#html_show_sphinx = True |
|
||||||
|
|
||||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
|
||||||
#html_show_copyright = True |
|
||||||
|
|
||||||
# If true, an OpenSearch description file will be output, and all pages will |
|
||||||
# contain a <link> tag referring to it. The value of this option must be the |
|
||||||
# base URL from which the finished HTML is served. |
|
||||||
#html_use_opensearch = '' |
|
||||||
|
|
||||||
# This is the file name suffix for HTML files (e.g. ".xhtml"). |
|
||||||
#html_file_suffix = None |
|
||||||
|
|
||||||
# Language to be used for generating the HTML full-text search index. |
|
||||||
# Sphinx supports the following languages: |
|
||||||
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' |
|
||||||
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' |
|
||||||
#html_search_language = 'en' |
|
||||||
|
|
||||||
# A dictionary with options for the search language support, empty by default. |
|
||||||
# Now only 'ja' uses this config value |
|
||||||
#html_search_options = {'type': 'default'} |
|
||||||
|
|
||||||
# The name of a javascript file (relative to the configuration directory) that |
|
||||||
# implements a search results scorer. If empty, the default will be used. |
|
||||||
#html_search_scorer = 'scorer.js' |
|
||||||
|
|
||||||
# Output file base name for HTML help builder. |
|
||||||
htmlhelp_basename = 'Remixdoc' |
|
||||||
|
|
||||||
# -- Options for LaTeX output --------------------------------------------- |
|
||||||
|
|
||||||
latex_elements = { |
|
||||||
# The paper size ('letterpaper' or 'a4paper'). |
|
||||||
#'papersize': 'letterpaper', |
|
||||||
|
|
||||||
# The font size ('10pt', '11pt' or '12pt'). |
|
||||||
#'pointsize': '10pt', |
|
||||||
|
|
||||||
# Additional stuff for the LaTeX preamble. |
|
||||||
#'preamble': '', |
|
||||||
|
|
||||||
# Latex figure (float) alignment |
|
||||||
#'figure_align': 'htbp', |
|
||||||
} |
|
||||||
|
|
||||||
# Grouping the document tree into LaTeX files. List of tuples |
|
||||||
# (source start file, target name, title, |
|
||||||
# author, documentclass [howto, manual, or own class]). |
|
||||||
latex_documents = [ |
|
||||||
(master_doc, 'Remix.tex', u'Remix Documentation', |
|
||||||
u'yann300', 'manual'), |
|
||||||
] |
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top of |
|
||||||
# the title page. |
|
||||||
#latex_logo = None |
|
||||||
|
|
||||||
# For "manual" documents, if this is true, then toplevel headings are parts, |
|
||||||
# not chapters. |
|
||||||
#latex_use_parts = False |
|
||||||
|
|
||||||
# If true, show page references after internal links. |
|
||||||
#latex_show_pagerefs = False |
|
||||||
|
|
||||||
# If true, show URL addresses after external links. |
|
||||||
#latex_show_urls = False |
|
||||||
|
|
||||||
# Documents to append as an appendix to all manuals. |
|
||||||
#latex_appendices = [] |
|
||||||
|
|
||||||
# If false, no module index is generated. |
|
||||||
#latex_domain_indices = True |
|
||||||
|
|
||||||
|
|
||||||
# -- Options for manual page output --------------------------------------- |
|
||||||
|
|
||||||
# One entry per manual page. List of tuples |
|
||||||
# (source start file, name, description, authors, manual section). |
|
||||||
man_pages = [ |
|
||||||
(master_doc, 'remix', u'Remix Documentation', |
|
||||||
[author], 1) |
|
||||||
] |
|
||||||
|
|
||||||
# If true, show URL addresses after external links. |
|
||||||
#man_show_urls = False |
|
||||||
|
|
||||||
|
|
||||||
# -- Options for Texinfo output ------------------------------------------- |
|
||||||
|
|
||||||
# Grouping the document tree into Texinfo files. List of tuples |
|
||||||
# (source start file, target name, title, author, |
|
||||||
# dir menu entry, description, category) |
|
||||||
texinfo_documents = [ |
|
||||||
(master_doc, 'Remix', u'Remix Documentation', |
|
||||||
author, 'Remix', 'One line description of project.', |
|
||||||
'Miscellaneous'), |
|
||||||
] |
|
||||||
|
|
||||||
# Documents to append as an appendix to all manuals. |
|
||||||
#texinfo_appendices = [] |
|
||||||
|
|
||||||
# If false, no module index is generated. |
|
||||||
#texinfo_domain_indices = True |
|
||||||
|
|
||||||
# How to display URL addresses: 'footnote', 'no', or 'inline'. |
|
||||||
#texinfo_show_urls = 'footnote' |
|
||||||
|
|
||||||
# If true, do not generate a @detailmenu in the "Top" node's menu. |
|
||||||
#texinfo_no_detailmenu = False |
|
||||||
|
|
||||||
from recommonmark.parser import CommonMarkParser |
|
||||||
source_suffix = ['.rst', '.md'] |
|
||||||
source_parsers = {'.md': CommonMarkParser} |
|
||||||
|
|
||||||
|
|
||||||
# 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) |
|
||||||
@ -1,4 +0,0 @@ |
|||||||
Remix documentation has moved! |
|
||||||
=============================== |
|
||||||
|
|
||||||
Please go to `remix-ide.readthedocs.io <http://remix-ide.readthedocs.io>`__ |
|
||||||
@ -1,263 +0,0 @@ |
|||||||
@ECHO OFF |
|
||||||
|
|
||||||
REM Command file for Sphinx documentation |
|
||||||
|
|
||||||
if "%SPHINXBUILD%" == "" ( |
|
||||||
set SPHINXBUILD=sphinx-build |
|
||||||
) |
|
||||||
set BUILDDIR=_build |
|
||||||
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . |
|
||||||
set I18NSPHINXOPTS=%SPHINXOPTS% . |
|
||||||
if NOT "%PAPER%" == "" ( |
|
||||||
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% |
|
||||||
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "" goto help |
|
||||||
|
|
||||||
if "%1" == "help" ( |
|
||||||
:help |
|
||||||
echo.Please use `make ^<target^>` where ^<target^> is one of |
|
||||||
echo. html to make standalone HTML files |
|
||||||
echo. dirhtml to make HTML files named index.html in directories |
|
||||||
echo. singlehtml to make a single large HTML file |
|
||||||
echo. pickle to make pickle files |
|
||||||
echo. json to make JSON files |
|
||||||
echo. htmlhelp to make HTML files and a HTML help project |
|
||||||
echo. qthelp to make HTML files and a qthelp project |
|
||||||
echo. devhelp to make HTML files and a Devhelp project |
|
||||||
echo. epub to make an epub |
|
||||||
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter |
|
||||||
echo. text to make text files |
|
||||||
echo. man to make manual pages |
|
||||||
echo. texinfo to make Texinfo files |
|
||||||
echo. gettext to make PO message catalogs |
|
||||||
echo. changes to make an overview over all changed/added/deprecated items |
|
||||||
echo. xml to make Docutils-native XML files |
|
||||||
echo. pseudoxml to make pseudoxml-XML files for display purposes |
|
||||||
echo. linkcheck to check all external links for integrity |
|
||||||
echo. doctest to run all doctests embedded in the documentation if enabled |
|
||||||
echo. coverage to run coverage check of the documentation if enabled |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "clean" ( |
|
||||||
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i |
|
||||||
del /q /s %BUILDDIR%\* |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
|
|
||||||
REM Check if sphinx-build is available and fallback to Python version if any |
|
||||||
%SPHINXBUILD% 1>NUL 2>NUL |
|
||||||
if errorlevel 9009 goto sphinx_python |
|
||||||
goto sphinx_ok |
|
||||||
|
|
||||||
:sphinx_python |
|
||||||
|
|
||||||
set SPHINXBUILD=python -m sphinx.__init__ |
|
||||||
%SPHINXBUILD% 2> nul |
|
||||||
if errorlevel 9009 ( |
|
||||||
echo. |
|
||||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx |
|
||||||
echo.installed, then set the SPHINXBUILD environment variable to point |
|
||||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you |
|
||||||
echo.may add the Sphinx directory to PATH. |
|
||||||
echo. |
|
||||||
echo.If you don't have Sphinx installed, grab it from |
|
||||||
echo.http://sphinx-doc.org/ |
|
||||||
exit /b 1 |
|
||||||
) |
|
||||||
|
|
||||||
:sphinx_ok |
|
||||||
|
|
||||||
|
|
||||||
if "%1" == "html" ( |
|
||||||
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The HTML pages are in %BUILDDIR%/html. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "dirhtml" ( |
|
||||||
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "singlehtml" ( |
|
||||||
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "pickle" ( |
|
||||||
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished; now you can process the pickle files. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "json" ( |
|
||||||
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished; now you can process the JSON files. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "htmlhelp" ( |
|
||||||
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished; now you can run HTML Help Workshop with the ^ |
|
||||||
.hhp project file in %BUILDDIR%/htmlhelp. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "qthelp" ( |
|
||||||
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished; now you can run "qcollectiongenerator" with the ^ |
|
||||||
.qhcp project file in %BUILDDIR%/qthelp, like this: |
|
||||||
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Remix.qhcp |
|
||||||
echo.To view the help file: |
|
||||||
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Remix.ghc |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "devhelp" ( |
|
||||||
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "epub" ( |
|
||||||
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The epub file is in %BUILDDIR%/epub. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "latex" ( |
|
||||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "latexpdf" ( |
|
||||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex |
|
||||||
cd %BUILDDIR%/latex |
|
||||||
make all-pdf |
|
||||||
cd %~dp0 |
|
||||||
echo. |
|
||||||
echo.Build finished; the PDF files are in %BUILDDIR%/latex. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "latexpdfja" ( |
|
||||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex |
|
||||||
cd %BUILDDIR%/latex |
|
||||||
make all-pdf-ja |
|
||||||
cd %~dp0 |
|
||||||
echo. |
|
||||||
echo.Build finished; the PDF files are in %BUILDDIR%/latex. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "text" ( |
|
||||||
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The text files are in %BUILDDIR%/text. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "man" ( |
|
||||||
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The manual pages are in %BUILDDIR%/man. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "texinfo" ( |
|
||||||
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "gettext" ( |
|
||||||
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The message catalogs are in %BUILDDIR%/locale. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "changes" ( |
|
||||||
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.The overview file is in %BUILDDIR%/changes. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "linkcheck" ( |
|
||||||
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Link check complete; look for any errors in the above output ^ |
|
||||||
or in %BUILDDIR%/linkcheck/output.txt. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "doctest" ( |
|
||||||
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Testing of doctests in the sources finished, look at the ^ |
|
||||||
results in %BUILDDIR%/doctest/output.txt. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "coverage" ( |
|
||||||
%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Testing of coverage in the sources finished, look at the ^ |
|
||||||
results in %BUILDDIR%/coverage/python.txt. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "xml" ( |
|
||||||
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The XML files are in %BUILDDIR%/xml. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "pseudoxml" ( |
|
||||||
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
:end |
|
||||||
@ -1,216 +0,0 @@ |
|||||||
# Makefile for Sphinx documentation
|
|
||||||
#
|
|
||||||
|
|
||||||
# You can set these variables from the command line.
|
|
||||||
SPHINXOPTS =
|
|
||||||
SPHINXBUILD = sphinx-build
|
|
||||||
PAPER =
|
|
||||||
BUILDDIR = _build
|
|
||||||
|
|
||||||
# User-friendly check for sphinx-build
|
|
||||||
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) |
|
||||||
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) |
|
||||||
endif |
|
||||||
|
|
||||||
# Internal variables.
|
|
||||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
|
||||||
PAPEROPT_letter = -D latex_paper_size=letter
|
|
||||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
|
||||||
# the i18n builder cannot share the environment and doctrees with the others
|
|
||||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
|
||||||
|
|
||||||
.PHONY: help |
|
||||||
help: |
|
||||||
@echo "Please use \`make <target>' where <target> is one of"
|
|
||||||
@echo " html to make standalone HTML files"
|
|
||||||
@echo " dirhtml to make HTML files named index.html in directories"
|
|
||||||
@echo " singlehtml to make a single large HTML file"
|
|
||||||
@echo " pickle to make pickle files"
|
|
||||||
@echo " json to make JSON files"
|
|
||||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
|
||||||
@echo " qthelp to make HTML files and a qthelp project"
|
|
||||||
@echo " applehelp to make an Apple Help Book"
|
|
||||||
@echo " devhelp to make HTML files and a Devhelp project"
|
|
||||||
@echo " epub to make an epub"
|
|
||||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
|
||||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
|
||||||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
|
||||||
@echo " text to make text files"
|
|
||||||
@echo " man to make manual pages"
|
|
||||||
@echo " texinfo to make Texinfo files"
|
|
||||||
@echo " info to make Texinfo files and run them through makeinfo"
|
|
||||||
@echo " gettext to make PO message catalogs"
|
|
||||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
|
||||||
@echo " xml to make Docutils-native XML files"
|
|
||||||
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
|
||||||
@echo " linkcheck to check all external links for integrity"
|
|
||||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
|
||||||
@echo " coverage to run coverage check of the documentation (if enabled)"
|
|
||||||
|
|
||||||
.PHONY: clean |
|
||||||
clean: |
|
||||||
rm -rf $(BUILDDIR)/*
|
|
||||||
|
|
||||||
.PHONY: html |
|
||||||
html: |
|
||||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
|
||||||
|
|
||||||
.PHONY: dirhtml |
|
||||||
dirhtml: |
|
||||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
|
||||||
|
|
||||||
.PHONY: singlehtml |
|
||||||
singlehtml: |
|
||||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
|
||||||
|
|
||||||
.PHONY: pickle |
|
||||||
pickle: |
|
||||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
|
||||||
@echo
|
|
||||||
@echo "Build finished; now you can process the pickle files."
|
|
||||||
|
|
||||||
.PHONY: json |
|
||||||
json: |
|
||||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
|
||||||
@echo
|
|
||||||
@echo "Build finished; now you can process the JSON files."
|
|
||||||
|
|
||||||
.PHONY: htmlhelp |
|
||||||
htmlhelp: |
|
||||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
|
||||||
@echo
|
|
||||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
|
||||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
|
||||||
|
|
||||||
.PHONY: qthelp |
|
||||||
qthelp: |
|
||||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
|
||||||
@echo
|
|
||||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
|
||||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
|
||||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Remix.qhcp"
|
|
||||||
@echo "To view the help file:"
|
|
||||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Remix.qhc"
|
|
||||||
|
|
||||||
.PHONY: applehelp |
|
||||||
applehelp: |
|
||||||
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
|
|
||||||
@echo "N.B. You won't be able to view it unless you put it in" \
|
|
||||||
"~/Library/Documentation/Help or install it in your application" \
|
|
||||||
"bundle."
|
|
||||||
|
|
||||||
.PHONY: devhelp |
|
||||||
devhelp: |
|
||||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
|
||||||
@echo
|
|
||||||
@echo "Build finished."
|
|
||||||
@echo "To view the help file:"
|
|
||||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/Remix"
|
|
||||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Remix"
|
|
||||||
@echo "# devhelp"
|
|
||||||
|
|
||||||
.PHONY: epub |
|
||||||
epub: |
|
||||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
|
||||||
|
|
||||||
.PHONY: latex |
|
||||||
latex: |
|
||||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
||||||
@echo
|
|
||||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
|
||||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
|
||||||
"(use \`make latexpdf' here to do that automatically)."
|
|
||||||
|
|
||||||
.PHONY: latexpdf |
|
||||||
latexpdf: |
|
||||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
||||||
@echo "Running LaTeX files through pdflatex..."
|
|
||||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
|
||||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
|
||||||
|
|
||||||
.PHONY: latexpdfja |
|
||||||
latexpdfja: |
|
||||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
||||||
@echo "Running LaTeX files through platex and dvipdfmx..."
|
|
||||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
|
||||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
|
||||||
|
|
||||||
.PHONY: text |
|
||||||
text: |
|
||||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
|
||||||
|
|
||||||
.PHONY: man |
|
||||||
man: |
|
||||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
|
||||||
|
|
||||||
.PHONY: texinfo |
|
||||||
texinfo: |
|
||||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
|
||||||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
|
||||||
"(use \`make info' here to do that automatically)."
|
|
||||||
|
|
||||||
.PHONY: info |
|
||||||
info: |
|
||||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
|
||||||
@echo "Running Texinfo files through makeinfo..."
|
|
||||||
make -C $(BUILDDIR)/texinfo info
|
|
||||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
|
||||||
|
|
||||||
.PHONY: gettext |
|
||||||
gettext: |
|
||||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
|
||||||
|
|
||||||
.PHONY: changes |
|
||||||
changes: |
|
||||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
|
||||||
@echo
|
|
||||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
|
||||||
|
|
||||||
.PHONY: linkcheck |
|
||||||
linkcheck: |
|
||||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
|
||||||
@echo
|
|
||||||
@echo "Link check complete; look for any errors in the above output " \
|
|
||||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
|
||||||
|
|
||||||
.PHONY: doctest |
|
||||||
doctest: |
|
||||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
|
||||||
@echo "Testing of doctests in the sources finished, look at the " \
|
|
||||||
"results in $(BUILDDIR)/doctest/output.txt."
|
|
||||||
|
|
||||||
.PHONY: coverage |
|
||||||
coverage: |
|
||||||
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
|
|
||||||
@echo "Testing of coverage in the sources finished, look at the " \
|
|
||||||
"results in $(BUILDDIR)/coverage/python.txt."
|
|
||||||
|
|
||||||
.PHONY: xml |
|
||||||
xml: |
|
||||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
|
||||||
|
|
||||||
.PHONY: pseudoxml |
|
||||||
pseudoxml: |
|
||||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
|
||||||
@echo
|
|
||||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
|
||||||
@ -1,27 +0,0 @@ |
|||||||
Analysis |
|
||||||
======== |
|
||||||
|
|
||||||
This section gives information about the last compilation. |
|
||||||
By default, a new analysis is run at each compilation. |
|
||||||
|
|
||||||
The analysis tab gives detailed information about the contract code. It can help you avoid code mistakes and to enforce best practices. |
|
||||||
|
|
||||||
.. image:: images/remix_analysistab.png |
|
||||||
|
|
||||||
Here is the list of analyzers: |
|
||||||
|
|
||||||
- Security: |
|
||||||
- Transaction origin: Warns if tx.origin is used |
|
||||||
- Check effects: Avoid potential reentrancy bugs |
|
||||||
- Inline assembly: Use of Inline Assembly |
|
||||||
- Block timestamp: Semantics maybe unclear |
|
||||||
- Low level calls: Semantics maybe unclear |
|
||||||
- Block.blockhash usage: Semantics maybe unclear |
|
||||||
|
|
||||||
- Gas & Economy: |
|
||||||
- Gas costs: Warns if the gas requirements of the functions are too high |
|
||||||
- This on local calls: Invocation of local functions via this |
|
||||||
|
|
||||||
- Miscellaneous: |
|
||||||
- Constant functions: Checks for potentially constant functions |
|
||||||
- Similar variable names: Checks if variable names are too similar |
|
||||||
@ -1,20 +0,0 @@ |
|||||||
Compiling contracts |
|
||||||
=================== |
|
||||||
|
|
||||||
By default Remix triggers a compilation each time the current file is changed or another file is selected. |
|
||||||
If the contract has a lot of dependencies and takes a long time to compile, it is possible to disable the `autocompilation`. |
|
||||||
|
|
||||||
.. image:: images/remix_compiletab.png |
|
||||||
|
|
||||||
After each compilation, a list is updated with all the newly compiled contracts. |
|
||||||
|
|
||||||
`Details` modal dialog displays detailed information about the current selected contract. |
|
||||||
|
|
||||||
From this tab, you can also publish your contract to Swarm (only non abstract contracts can be published). |
|
||||||
|
|
||||||
Published data notably contains the ``abi`` and solidity source code. |
|
||||||
|
|
||||||
After a contract is published, you can find its metadata information using the `bzz` URL located in the details modal dialog ``SWARM LOCATION``. |
|
||||||
|
|
||||||
Compilation Errors and Warning are displayed below the contract section. At each compilation, the static analysis tab builds a report. It is very valuable when addressing reported issues even if the compiler doesn't complain. |
|
||||||
(see :doc:`../analysis_tab`) |
|
||||||
@ -1,283 +0,0 @@ |
|||||||
# -*- coding: utf-8 -*- |
|
||||||
# |
|
||||||
# Remix documentation build configuration file, created by |
|
||||||
# sphinx-quickstart on Mon Feb 20 12:16:16 2017. |
|
||||||
# |
|
||||||
# This file is execfile()d with the current directory set to its |
|
||||||
# containing dir. |
|
||||||
# |
|
||||||
# Note that not all possible configuration values are present in this |
|
||||||
# autogenerated file. |
|
||||||
# |
|
||||||
# All configuration values have a default; values that are commented out |
|
||||||
# serve to show the default. |
|
||||||
|
|
||||||
import sys |
|
||||||
import os |
|
||||||
|
|
||||||
# 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('.')) |
|
||||||
|
|
||||||
# -- General configuration ------------------------------------------------ |
|
||||||
|
|
||||||
# If your documentation needs a minimal Sphinx version, state it here. |
|
||||||
#needs_sphinx = '1.0' |
|
||||||
|
|
||||||
# Add any Sphinx extension module names here, as strings. They can be |
|
||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
|
||||||
# ones. |
|
||||||
extensions = [] |
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory. |
|
||||||
templates_path = ['_templates'] |
|
||||||
|
|
||||||
# The suffix(es) of source filenames. |
|
||||||
# You can specify multiple suffix as a list of string: |
|
||||||
# source_suffix = ['.rst', '.md'] |
|
||||||
source_suffix = '.md' |
|
||||||
|
|
||||||
# The encoding of source files. |
|
||||||
#source_encoding = 'utf-8-sig' |
|
||||||
|
|
||||||
# The master toctree document. |
|
||||||
master_doc = 'index' |
|
||||||
|
|
||||||
# General information about the project. |
|
||||||
project = u'Remix' |
|
||||||
copyright = u'2017, yann300' |
|
||||||
author = u'yann300' |
|
||||||
|
|
||||||
# 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. |
|
||||||
# |
|
||||||
# The short X.Y version. |
|
||||||
version = u'1' |
|
||||||
# The full version, including alpha/beta/rc tags. |
|
||||||
release = u'1' |
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation |
|
||||||
# for a list of supported languages. |
|
||||||
# |
|
||||||
# This is also used if you do content translation via gettext catalogs. |
|
||||||
# Usually you set "language" from the command line for these cases. |
|
||||||
language = None |
|
||||||
|
|
||||||
# There are two options for replacing |today|: either, you set today to some |
|
||||||
# non-false value, then it is used: |
|
||||||
#today = '' |
|
||||||
# Else, today_fmt is used as the format for a strftime call. |
|
||||||
#today_fmt = '%B %d, %Y' |
|
||||||
|
|
||||||
# List of patterns, relative to source directory, that match files and |
|
||||||
# directories to ignore when looking for source files. |
|
||||||
exclude_patterns = ['_build'] |
|
||||||
|
|
||||||
# The reST default role (used for this markup: `text`) to use for all |
|
||||||
# documents. |
|
||||||
#default_role = None |
|
||||||
|
|
||||||
# If true, '()' will be appended to :func: etc. cross-reference text. |
|
||||||
#add_function_parentheses = True |
|
||||||
|
|
||||||
# If true, the current module name will be prepended to all description |
|
||||||
# unit titles (such as .. function::). |
|
||||||
#add_module_names = True |
|
||||||
|
|
||||||
# If true, sectionauthor and moduleauthor directives will be shown in the |
|
||||||
# output. They are ignored by default. |
|
||||||
#show_authors = False |
|
||||||
|
|
||||||
# The name of the Pygments (syntax highlighting) style to use. |
|
||||||
pygments_style = 'sphinx' |
|
||||||
|
|
||||||
# A list of ignored prefixes for module index sorting. |
|
||||||
#modindex_common_prefix = [] |
|
||||||
|
|
||||||
# If true, keep warnings as "system message" paragraphs in the built documents. |
|
||||||
#keep_warnings = False |
|
||||||
|
|
||||||
# If true, `todo` and `todoList` produce output, else they produce nothing. |
|
||||||
todo_include_todos = False |
|
||||||
|
|
||||||
|
|
||||||
# -- Options for HTML output ---------------------------------------------- |
|
||||||
|
|
||||||
# The theme to use for HTML and HTML Help pages. See the documentation for |
|
||||||
# a list of builtin themes. |
|
||||||
html_theme = 'alabaster' |
|
||||||
|
|
||||||
# Theme options are theme-specific and customize the look and feel of a theme |
|
||||||
# further. For a list of options available for each theme, see the |
|
||||||
# documentation. |
|
||||||
#html_theme_options = {} |
|
||||||
|
|
||||||
# Add any paths that contain custom themes here, relative to this directory. |
|
||||||
#html_theme_path = [] |
|
||||||
|
|
||||||
# The name for this set of Sphinx documents. If None, it defaults to |
|
||||||
# "<project> v<release> documentation". |
|
||||||
#html_title = None |
|
||||||
|
|
||||||
# A shorter title for the navigation bar. Default is the same as html_title. |
|
||||||
#html_short_title = None |
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top |
|
||||||
# of the sidebar. |
|
||||||
#html_logo = None |
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to use as a favicon of |
|
||||||
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
|
||||||
# pixels large. |
|
||||||
#html_favicon = None |
|
||||||
|
|
||||||
# Add any paths that contain custom static files (such as style sheets) here, |
|
||||||
# relative to this directory. They are copied after the builtin static files, |
|
||||||
# so a file named "default.css" will overwrite the builtin "default.css". |
|
||||||
html_static_path = ['_static'] |
|
||||||
|
|
||||||
# Add any extra paths that contain custom files (such as robots.txt or |
|
||||||
# .htaccess) here, relative to this directory. These files are copied |
|
||||||
# directly to the root of the documentation. |
|
||||||
#html_extra_path = [] |
|
||||||
|
|
||||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
|
||||||
# using the given strftime format. |
|
||||||
#html_last_updated_fmt = '%b %d, %Y' |
|
||||||
|
|
||||||
# If true, SmartyPants will be used to convert quotes and dashes to |
|
||||||
# typographically correct entities. |
|
||||||
#html_use_smartypants = True |
|
||||||
|
|
||||||
# Custom sidebar templates, maps document names to template names. |
|
||||||
#html_sidebars = {} |
|
||||||
|
|
||||||
# Additional templates that should be rendered to pages, maps page names to |
|
||||||
# template names. |
|
||||||
#html_additional_pages = {} |
|
||||||
|
|
||||||
# If false, no module index is generated. |
|
||||||
#html_domain_indices = True |
|
||||||
|
|
||||||
# If false, no index is generated. |
|
||||||
#html_use_index = True |
|
||||||
|
|
||||||
# If true, the index is split into individual pages for each letter. |
|
||||||
#html_split_index = False |
|
||||||
|
|
||||||
# If true, links to the reST sources are added to the pages. |
|
||||||
#html_show_sourcelink = True |
|
||||||
|
|
||||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
|
||||||
#html_show_sphinx = True |
|
||||||
|
|
||||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
|
||||||
#html_show_copyright = True |
|
||||||
|
|
||||||
# If true, an OpenSearch description file will be output, and all pages will |
|
||||||
# contain a <link> tag referring to it. The value of this option must be the |
|
||||||
# base URL from which the finished HTML is served. |
|
||||||
#html_use_opensearch = '' |
|
||||||
|
|
||||||
# This is the file name suffix for HTML files (e.g. ".xhtml"). |
|
||||||
#html_file_suffix = None |
|
||||||
|
|
||||||
# Language to be used for generating the HTML full-text search index. |
|
||||||
# Sphinx supports the following languages: |
|
||||||
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' |
|
||||||
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' |
|
||||||
#html_search_language = 'en' |
|
||||||
|
|
||||||
# A dictionary with options for the search language support, empty by default. |
|
||||||
# Now only 'ja' uses this config value |
|
||||||
#html_search_options = {'type': 'default'} |
|
||||||
|
|
||||||
# The name of a javascript file (relative to the configuration directory) that |
|
||||||
# implements a search results scorer. If empty, the default will be used. |
|
||||||
#html_search_scorer = 'scorer.js' |
|
||||||
|
|
||||||
# Output file base name for HTML help builder. |
|
||||||
htmlhelp_basename = 'Remixdoc' |
|
||||||
|
|
||||||
# -- Options for LaTeX output --------------------------------------------- |
|
||||||
|
|
||||||
latex_elements = { |
|
||||||
# The paper size ('letterpaper' or 'a4paper'). |
|
||||||
#'papersize': 'letterpaper', |
|
||||||
|
|
||||||
# The font size ('10pt', '11pt' or '12pt'). |
|
||||||
#'pointsize': '10pt', |
|
||||||
|
|
||||||
# Additional stuff for the LaTeX preamble. |
|
||||||
#'preamble': '', |
|
||||||
|
|
||||||
# Latex figure (float) alignment |
|
||||||
#'figure_align': 'htbp', |
|
||||||
} |
|
||||||
|
|
||||||
# Grouping the document tree into LaTeX files. List of tuples |
|
||||||
# (source start file, target name, title, |
|
||||||
# author, documentclass [howto, manual, or own class]). |
|
||||||
latex_documents = [ |
|
||||||
(master_doc, 'Remix.tex', u'Remix Documentation', |
|
||||||
u'yann300', 'manual'), |
|
||||||
] |
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top of |
|
||||||
# the title page. |
|
||||||
#latex_logo = None |
|
||||||
|
|
||||||
# For "manual" documents, if this is true, then toplevel headings are parts, |
|
||||||
# not chapters. |
|
||||||
#latex_use_parts = False |
|
||||||
|
|
||||||
# If true, show page references after internal links. |
|
||||||
#latex_show_pagerefs = False |
|
||||||
|
|
||||||
# If true, show URL addresses after external links. |
|
||||||
#latex_show_urls = False |
|
||||||
|
|
||||||
# Documents to append as an appendix to all manuals. |
|
||||||
#latex_appendices = [] |
|
||||||
|
|
||||||
# If false, no module index is generated. |
|
||||||
#latex_domain_indices = True |
|
||||||
|
|
||||||
|
|
||||||
# -- Options for manual page output --------------------------------------- |
|
||||||
|
|
||||||
# One entry per manual page. List of tuples |
|
||||||
# (source start file, name, description, authors, manual section). |
|
||||||
man_pages = [ |
|
||||||
(master_doc, 'remix', u'Remix Documentation', |
|
||||||
[author], 1) |
|
||||||
] |
|
||||||
|
|
||||||
# If true, show URL addresses after external links. |
|
||||||
#man_show_urls = False |
|
||||||
|
|
||||||
|
|
||||||
# -- Options for Texinfo output ------------------------------------------- |
|
||||||
|
|
||||||
# Grouping the document tree into Texinfo files. List of tuples |
|
||||||
# (source start file, target name, title, author, |
|
||||||
# dir menu entry, description, category) |
|
||||||
texinfo_documents = [ |
|
||||||
(master_doc, 'Remix', u'Remix Documentation', |
|
||||||
author, 'Remix', 'One line description of project.', |
|
||||||
'Miscellaneous'), |
|
||||||
] |
|
||||||
|
|
||||||
# Documents to append as an appendix to all manuals. |
|
||||||
#texinfo_appendices = [] |
|
||||||
|
|
||||||
# If false, no module index is generated. |
|
||||||
#texinfo_domain_indices = True |
|
||||||
|
|
||||||
# How to display URL addresses: 'footnote', 'no', or 'inline'. |
|
||||||
#texinfo_show_urls = 'footnote' |
|
||||||
|
|
||||||
# If true, do not generate a @detailmenu in the "Top" node's menu. |
|
||||||
#texinfo_no_detailmenu = False |
|
||||||
@ -1,11 +0,0 @@ |
|||||||
Debugging |
|
||||||
========= |
|
||||||
|
|
||||||
This module allows you to debug the transaction. |
|
||||||
It can be used to deploy transactions created from Remix and already mined transactions. |
|
||||||
(debugging works only if the current environment provides the necessary features). |
|
||||||
|
|
||||||
.. image:: images/remix_debuggertab.png |
|
||||||
|
|
||||||
For more information about debugging, click on the following link: |
|
||||||
:doc:`../tutorial_debug` |
|
||||||
@ -1,37 +0,0 @@ |
|||||||
File Explorer |
|
||||||
============= |
|
||||||
|
|
||||||
The file explorer lists by default all the files stored in your browser. You can see them in the `browser` folder. You can always rename, remove or add new files to the file explorer. |
|
||||||
|
|
||||||
.. image:: images/remix_file_explorer_browser.png |
|
||||||
|
|
||||||
Note that clearing the browser storage will permanently delete all the solidity files you wrote. To avoid this, you can use Remixd, which enables you to store and sync files in the browser with your local computer (for more information see :doc:`../tutorial_remixd_filesystem`) |
|
||||||
|
|
||||||
.. image:: images/remix_file_explorer_menu.png |
|
||||||
|
|
||||||
We will start by reviewing at the icons at the top left - from left to the right: |
|
||||||
|
|
||||||
Create new File |
|
||||||
--------------- |
|
||||||
|
|
||||||
Creates a new file in the `browser` explorer. |
|
||||||
|
|
||||||
Add Local File |
|
||||||
-------------- |
|
||||||
|
|
||||||
Allows you to select files from the local file system and import them to the Remix browser storage. |
|
||||||
|
|
||||||
Publish to Gist |
|
||||||
--------------- |
|
||||||
|
|
||||||
Publishes files from the browser storage to an anonymous public gist. |
|
||||||
|
|
||||||
Copy to another instance |
|
||||||
------------------------ |
|
||||||
|
|
||||||
Enables you to copy files from the browser storage to another instance (URL) of Remix. |
|
||||||
|
|
||||||
Connect to Localhost |
|
||||||
-------------------- |
|
||||||
|
|
||||||
Allows to use file located in your file system (see :doc:`../tutorial_remixd_filesystem`). |
|
||||||
|
Before Width: | Height: | Size: 302 KiB |
|
Before Width: | Height: | Size: 196 KiB |
|
Before Width: | Height: | Size: 184 KiB |
|
Before Width: | Height: | Size: 195 KiB |
|
Before Width: | Height: | Size: 196 KiB |
|
Before Width: | Height: | Size: 195 KiB |
|
Before Width: | Height: | Size: 103 KiB |
|
Before Width: | Height: | Size: 86 KiB |
|
Before Width: | Height: | Size: 111 KiB |
|
Before Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 201 KiB |
|
Before Width: | Height: | Size: 304 KiB |
|
Before Width: | Height: | Size: 190 KiB |
|
Before Width: | Height: | Size: 336 KiB |
|
Before Width: | Height: | Size: 195 KiB |
@ -1,60 +0,0 @@ |
|||||||
Remix - Solidity IDE |
|
||||||
==================== |
|
||||||
|
|
||||||
Remix is an IDE for the smart contract programming language Solidity and has |
|
||||||
an integrated debugger and testing environment. |
|
||||||
|
|
||||||
An up to date online version is available at `remix.ethereum.org <http://remix.ethereum.org>`_ |
|
||||||
|
|
||||||
This page will host documentation and tutorial about features Remix provides. |
|
||||||
|
|
||||||
Please go to `solidity.readthedocs.io <http://solidity.readthedocs.io>`_ for any information regarding ``Solidity`` |
|
||||||
|
|
||||||
Overview |
|
||||||
-------- |
|
||||||
|
|
||||||
Remix provides an integrated development environment (IDE) for smart contract development. |
|
||||||
It focuses on the development and deployment of Solidity written smart contracts. |
|
||||||
|
|
||||||
Remix is a good solution if you intend to: |
|
||||||
|
|
||||||
- Develop smart contracts (remix integrates a solidity editor). |
|
||||||
- Debug a smart contract's execution. |
|
||||||
- Access the state and properties of already deployed smart contract. |
|
||||||
- Debug already committed transaction. |
|
||||||
- Analyze solidity code to reduce coding mistakes and to enforce best practices. |
|
||||||
- Together with Mist (or any tool which inject web3), Remix can be used to test and debug a Dapp (see :doc:`../tutorial_mist`) |
|
||||||
|
|
||||||
Developing smart contract requires a deep understanding of the associated Blockchain technology. |
|
||||||
|
|
||||||
!! Don't use Remix against a production network unless you are completely sure what you are doing !! |
|
||||||
|
|
||||||
This documentation describes all the features remix provides. |
|
||||||
The GUI can be separated in 4 parts. Click on one the link to get more information. |
|
||||||
|
|
||||||
- :doc:`../file_explorer` |
|
||||||
- :doc:`../solidity_editor` |
|
||||||
- :doc:`../terminal` |
|
||||||
- :doc:`../tabs_panel` |
|
||||||
- :doc:`../compile_tab` |
|
||||||
- :doc:`../run_tab` |
|
||||||
- :doc:`../settings_tab` |
|
||||||
- :doc:`../debugger_tab` |
|
||||||
- :doc:`../analysis_tab` |
|
||||||
- :doc:`../support_tab` |
|
||||||
|
|
||||||
Quick Start |
|
||||||
----------- |
|
||||||
|
|
||||||
(see :doc:`../quickstart_javascriptvm`) |
|
||||||
|
|
||||||
Tutorial |
|
||||||
-------- |
|
||||||
|
|
||||||
.. toctree:: |
|
||||||
:maxdepth: 1 |
|
||||||
|
|
||||||
tutorial_remixd_filesystem.rst |
|
||||||
tutorial_mist.rst |
|
||||||
tutorial_debug.rst |
|
||||||
tutorial_import.rst |
|
||||||
@ -1,263 +0,0 @@ |
|||||||
@ECHO OFF |
|
||||||
|
|
||||||
REM Command file for Sphinx documentation |
|
||||||
|
|
||||||
if "%SPHINXBUILD%" == "" ( |
|
||||||
set SPHINXBUILD=sphinx-build |
|
||||||
) |
|
||||||
set BUILDDIR=_build |
|
||||||
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . |
|
||||||
set I18NSPHINXOPTS=%SPHINXOPTS% . |
|
||||||
if NOT "%PAPER%" == "" ( |
|
||||||
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% |
|
||||||
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "" goto help |
|
||||||
|
|
||||||
if "%1" == "help" ( |
|
||||||
:help |
|
||||||
echo.Please use `make ^<target^>` where ^<target^> is one of |
|
||||||
echo. html to make standalone HTML files |
|
||||||
echo. dirhtml to make HTML files named index.html in directories |
|
||||||
echo. singlehtml to make a single large HTML file |
|
||||||
echo. pickle to make pickle files |
|
||||||
echo. json to make JSON files |
|
||||||
echo. htmlhelp to make HTML files and a HTML help project |
|
||||||
echo. qthelp to make HTML files and a qthelp project |
|
||||||
echo. devhelp to make HTML files and a Devhelp project |
|
||||||
echo. epub to make an epub |
|
||||||
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter |
|
||||||
echo. text to make text files |
|
||||||
echo. man to make manual pages |
|
||||||
echo. texinfo to make Texinfo files |
|
||||||
echo. gettext to make PO message catalogs |
|
||||||
echo. changes to make an overview over all changed/added/deprecated items |
|
||||||
echo. xml to make Docutils-native XML files |
|
||||||
echo. pseudoxml to make pseudoxml-XML files for display purposes |
|
||||||
echo. linkcheck to check all external links for integrity |
|
||||||
echo. doctest to run all doctests embedded in the documentation if enabled |
|
||||||
echo. coverage to run coverage check of the documentation if enabled |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "clean" ( |
|
||||||
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i |
|
||||||
del /q /s %BUILDDIR%\* |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
|
|
||||||
REM Check if sphinx-build is available and fallback to Python version if any |
|
||||||
%SPHINXBUILD% 1>NUL 2>NUL |
|
||||||
if errorlevel 9009 goto sphinx_python |
|
||||||
goto sphinx_ok |
|
||||||
|
|
||||||
:sphinx_python |
|
||||||
|
|
||||||
set SPHINXBUILD=python -m sphinx.__init__ |
|
||||||
%SPHINXBUILD% 2> nul |
|
||||||
if errorlevel 9009 ( |
|
||||||
echo. |
|
||||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx |
|
||||||
echo.installed, then set the SPHINXBUILD environment variable to point |
|
||||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you |
|
||||||
echo.may add the Sphinx directory to PATH. |
|
||||||
echo. |
|
||||||
echo.If you don't have Sphinx installed, grab it from |
|
||||||
echo.http://sphinx-doc.org/ |
|
||||||
exit /b 1 |
|
||||||
) |
|
||||||
|
|
||||||
:sphinx_ok |
|
||||||
|
|
||||||
|
|
||||||
if "%1" == "html" ( |
|
||||||
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The HTML pages are in %BUILDDIR%/html. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "dirhtml" ( |
|
||||||
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "singlehtml" ( |
|
||||||
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "pickle" ( |
|
||||||
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished; now you can process the pickle files. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "json" ( |
|
||||||
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished; now you can process the JSON files. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "htmlhelp" ( |
|
||||||
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished; now you can run HTML Help Workshop with the ^ |
|
||||||
.hhp project file in %BUILDDIR%/htmlhelp. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "qthelp" ( |
|
||||||
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished; now you can run "qcollectiongenerator" with the ^ |
|
||||||
.qhcp project file in %BUILDDIR%/qthelp, like this: |
|
||||||
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Remix.qhcp |
|
||||||
echo.To view the help file: |
|
||||||
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Remix.ghc |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "devhelp" ( |
|
||||||
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "epub" ( |
|
||||||
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The epub file is in %BUILDDIR%/epub. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "latex" ( |
|
||||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "latexpdf" ( |
|
||||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex |
|
||||||
cd %BUILDDIR%/latex |
|
||||||
make all-pdf |
|
||||||
cd %~dp0 |
|
||||||
echo. |
|
||||||
echo.Build finished; the PDF files are in %BUILDDIR%/latex. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "latexpdfja" ( |
|
||||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex |
|
||||||
cd %BUILDDIR%/latex |
|
||||||
make all-pdf-ja |
|
||||||
cd %~dp0 |
|
||||||
echo. |
|
||||||
echo.Build finished; the PDF files are in %BUILDDIR%/latex. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "text" ( |
|
||||||
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The text files are in %BUILDDIR%/text. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "man" ( |
|
||||||
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The manual pages are in %BUILDDIR%/man. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "texinfo" ( |
|
||||||
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "gettext" ( |
|
||||||
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The message catalogs are in %BUILDDIR%/locale. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "changes" ( |
|
||||||
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.The overview file is in %BUILDDIR%/changes. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "linkcheck" ( |
|
||||||
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Link check complete; look for any errors in the above output ^ |
|
||||||
or in %BUILDDIR%/linkcheck/output.txt. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "doctest" ( |
|
||||||
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Testing of doctests in the sources finished, look at the ^ |
|
||||||
results in %BUILDDIR%/doctest/output.txt. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "coverage" ( |
|
||||||
%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Testing of coverage in the sources finished, look at the ^ |
|
||||||
results in %BUILDDIR%/coverage/python.txt. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "xml" ( |
|
||||||
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The XML files are in %BUILDDIR%/xml. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
if "%1" == "pseudoxml" ( |
|
||||||
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml |
|
||||||
if errorlevel 1 exit /b 1 |
|
||||||
echo. |
|
||||||
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. |
|
||||||
goto end |
|
||||||
) |
|
||||||
|
|
||||||
:end |
|
||||||
|
Before Width: | Height: | Size: 7.9 KiB |
@ -1,86 +0,0 @@ |
|||||||
Quick Start using the JavaScript VM |
|
||||||
=================================== |
|
||||||
|
|
||||||
There are 3 type of environments Remix can be plugged to: ``Javascript VM``, ``Injected provider``, or ``Web3 provider``. (see :doc:`../run_tab`) |
|
||||||
|
|
||||||
Both ``Web3 provider`` and ``Injected provider`` require the use of an external tool. |
|
||||||
|
|
||||||
The external tool for ``Web3 provider`` is an Ethereum node the tools for ``Injected provider`` are Mist or Metamask. |
|
||||||
|
|
||||||
The ``JavaScript VM`` mode is convenient because each execution runs in your browser. |
|
||||||
Thus reloading the page will restart Remix with an empty state. |
|
||||||
|
|
||||||
So for performance purposes, it might also be better to use an external node. |
|
||||||
|
|
||||||
Selecting the VM mode |
|
||||||
--------------------- |
|
||||||
|
|
||||||
Make sure the VM mode is selected. All accounts displayed in ``Accounts`` should have 100 ether. |
|
||||||
|
|
||||||
Sample contract |
|
||||||
--------------- |
|
||||||
|
|
||||||
.. code-block:: none |
|
||||||
|
|
||||||
pragma solidity ^0.4.16; |
|
||||||
contract testContract { |
|
||||||
|
|
||||||
uint value; |
|
||||||
function testContract(uint _p) { |
|
||||||
value = _p; |
|
||||||
} |
|
||||||
|
|
||||||
function setP(uint _n) payable { |
|
||||||
value = _n; |
|
||||||
} |
|
||||||
|
|
||||||
function setNP(uint _n) { |
|
||||||
value = _n; |
|
||||||
} |
|
||||||
|
|
||||||
function get () constant returns (uint) { |
|
||||||
return value; |
|
||||||
} |
|
||||||
} |
|
||||||
|
|
||||||
This contract is very basic. The goal is to quickly start to create and to interact with a sample contract. |
|
||||||
|
|
||||||
Deploying an instance |
|
||||||
--------------------- |
|
||||||
|
|
||||||
The ``Compile tab`` displays information related to the current contract (note that there can be more than one) (see :doc:`../compile_tab`). |
|
||||||
|
|
||||||
Moving on, in the ``Run tab`` select, ``JavaScript VM`` to specify that you are going to deploy an instance of the contract in the ``JavaScript VM`` state. |
|
||||||
|
|
||||||
.. image:: images/remix_quickstart_javascriptvm_creation.png |
|
||||||
|
|
||||||
The constructor of ``testContract`` needs a parameter (of type ``uint``). Give any value and click on ``Create``. |
|
||||||
|
|
||||||
The transaction which deploys the instance of ``testContract`` is created. |
|
||||||
|
|
||||||
In a "normal" blockchain, it can take several seconds to execute. This is the time for the transaction to be mined. However, because we are using the ``JavaScript VM``, our execution is immediate. |
|
||||||
|
|
||||||
The terminal will inform you about the transaction. You can see details there and start debugging. |
|
||||||
|
|
||||||
The newly created instance is displayed in the ``run tab``. |
|
||||||
|
|
||||||
.. image:: images/remix_quickstart_javascriptvm_creationTransaction.png |
|
||||||
|
|
||||||
Interacting with an instance |
|
||||||
---------------------------- |
|
||||||
|
|
||||||
This new instance contains 3 actions which corresponds to the 3 functions (``setP``, ``setPN``, ``get``). |
|
||||||
Clicking on ``SetP`` or ``SetPN`` will create a new transaction. |
|
||||||
|
|
||||||
Note that ``SetP`` is ``payable`` (red action) : it is possible to send value (Ether) to the contract. |
|
||||||
|
|
||||||
``SetPN`` is not payable (light red action) : it is not possible to send value (Ether) to the contract. |
|
||||||
|
|
||||||
Clicking on ``get`` will not execute a transaction (blue action). It is not necessary to do so because ``get`` does not modify the state (variable ``value``) of this instance. |
|
||||||
|
|
||||||
As ``get`` is ``constant`` you can see the return value just below the action. |
|
||||||
|
|
||||||
.. image:: images/remix_quickstart_javascriptvm_callinginstance.png |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Before Width: | Height: | Size: 198 KiB |
|
Before Width: | Height: | Size: 210 KiB |
|
Before Width: | Height: | Size: 203 KiB |
|
Before Width: | Height: | Size: 213 KiB |
|
Before Width: | Height: | Size: 192 KiB |
|
Before Width: | Height: | Size: 269 KiB |
|
Before Width: | Height: | Size: 268 KiB |
|
Before Width: | Height: | Size: 287 KiB |
|
Before Width: | Height: | Size: 265 KiB |
|
Before Width: | Height: | Size: 283 KiB |
|
Before Width: | Height: | Size: 266 KiB |
|
Before Width: | Height: | Size: 265 KiB |
|
Before Width: | Height: | Size: 270 KiB |
|
Before Width: | Height: | Size: 107 KiB |
|
Before Width: | Height: | Size: 266 KiB |
|
Before Width: | Height: | Size: 249 KiB |
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue