mirror of https://github.com/embarklabs/embark.git
update docs
This commit is contained in:
parent
d9bb63b731
commit
769fa63fa5
|
@ -5,5 +5,5 @@ demo/dist/
|
||||||
demo/.embark/development/
|
demo/.embark/development/
|
||||||
demo/config/production/password
|
demo/config/production/password
|
||||||
boilerplate/dist/
|
boilerplate/dist/
|
||||||
docs/build
|
docs/_build
|
||||||
docs/utils/__pycache_
|
docs/utils/__pycache_
|
||||||
|
|
|
@ -5,8 +5,8 @@
|
||||||
SPHINXOPTS =
|
SPHINXOPTS =
|
||||||
SPHINXBUILD = sphinx-build
|
SPHINXBUILD = sphinx-build
|
||||||
SPHINXPROJ = embark
|
SPHINXPROJ = embark
|
||||||
SOURCEDIR = source
|
SOURCEDIR = .
|
||||||
BUILDDIR = build
|
BUILDDIR = _build
|
||||||
|
|
||||||
# Put it first so that "make" without argument is like "make help".
|
# Put it first so that "make" without argument is like "make help".
|
||||||
help:
|
help:
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
#
|
#
|
||||||
# embark documentation build configuration file, created by
|
# embark documentation build configuration file, created by
|
||||||
# sphinx-quickstart on Tue Jan 10 05:57:43 2017.
|
# sphinx-quickstart on Tue Jan 10 06:39:27 2017.
|
||||||
#
|
#
|
||||||
# This file is execfile()d with the current directory set to its
|
# This file is execfile()d with the current directory set to its
|
||||||
# containing dir.
|
# containing dir.
|
||||||
|
@ -34,7 +34,7 @@
|
||||||
extensions = []
|
extensions = []
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = ['ntemplates']
|
templates_path = ['_templates']
|
||||||
|
|
||||||
# The suffix(es) of source filenames.
|
# The suffix(es) of source filenames.
|
||||||
# You can specify multiple suffix as a list of string:
|
# You can specify multiple suffix as a list of string:
|
||||||
|
@ -69,7 +69,7 @@ language = None
|
||||||
# List of patterns, relative to source directory, that match files and
|
# List of patterns, relative to source directory, that match files and
|
||||||
# directories to ignore when looking for source files.
|
# directories to ignore when looking for source files.
|
||||||
# This patterns also effect to html_static_path and html_extra_path
|
# This patterns also effect to html_static_path and html_extra_path
|
||||||
exclude_patterns = []
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||||
|
|
||||||
# The name of the Pygments (syntax highlighting) style to use.
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
pygments_style = 'sphinx'
|
pygments_style = 'sphinx'
|
||||||
|
@ -94,7 +94,7 @@ html_theme = 'alabaster'
|
||||||
# Add any paths that contain custom static files (such as style sheets) here,
|
# 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,
|
# relative to this directory. They are copied after the builtin static files,
|
||||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||||
html_static_path = ['nstatic']
|
html_static_path = ['_static']
|
||||||
|
|
||||||
|
|
||||||
# -- Options for HTMLHelp output ------------------------------------------
|
# -- Options for HTMLHelp output ------------------------------------------
|
|
@ -0,0 +1,22 @@
|
||||||
|
.. embark documentation master file, created by
|
||||||
|
sphinx-quickstart on Tue Jan 10 06:39:27 2017.
|
||||||
|
You can adapt this file completely to your liking, but it should at least
|
||||||
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
|
Welcome to embark's documentation!
|
||||||
|
==================================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
:caption: Contents:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Indices and tables
|
||||||
|
==================
|
||||||
|
|
||||||
|
* :ref:`genindex`
|
||||||
|
* :ref:`modindex`
|
||||||
|
* :ref:`search`
|
||||||
|
|
||||||
|
Hello World!
|
|
@ -7,8 +7,8 @@ REM Command file for Sphinx documentation
|
||||||
if "%SPHINXBUILD%" == "" (
|
if "%SPHINXBUILD%" == "" (
|
||||||
set SPHINXBUILD=sphinx-build
|
set SPHINXBUILD=sphinx-build
|
||||||
)
|
)
|
||||||
set SOURCEDIR=source
|
set SOURCEDIR=.
|
||||||
set BUILDDIR=build
|
set BUILDDIR=_build
|
||||||
set SPHINXPROJ=embark
|
set SPHINXPROJ=embark
|
||||||
|
|
||||||
if "%1" == "" goto help
|
if "%1" == "" goto help
|
||||||
|
|
|
@ -1,34 +0,0 @@
|
||||||
.. embark documentation master file, created by
|
|
||||||
sphinx-quickstart on Tue Jan 10 05:57:43 2017.
|
|
||||||
You can adapt this file completely to your liking, but it should at least
|
|
||||||
contain the root `toctree` directive.
|
|
||||||
|
|
||||||
Welcome to embark's documentation!
|
|
||||||
==================================
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
:caption: Contents:
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Indices and tables
|
|
||||||
==================
|
|
||||||
|
|
||||||
* :ref:`genindex`
|
|
||||||
* :ref:`modindex`
|
|
||||||
* :ref:`search`
|
|
||||||
|
|
||||||
What is Embark
|
|
||||||
|
|
||||||
Embark is a framework that allows you to easily develop and deploy DApps.
|
|
||||||
|
|
||||||
With Embark you can:
|
|
||||||
* Automatically deploy contracts and make them available in your JS code. Embark watches for changes, and if you update a contract, Embark will automatically redeploy the contracts (if needed) and the dapp.
|
|
||||||
* Use any build pipeline or tool you wish, including grunt and meteor. (for 1.x, plugins coming soon for 2.x series)
|
|
||||||
* Do Test Driven Development with Contracts using Javascript.
|
|
||||||
* Easily deploy to & use decentralized systems such as IPFS.
|
|
||||||
* Keep track of deployed contracts, deploy only when truly needed.
|
|
||||||
* Manage different chains (e.g testnet, private net, livenet)
|
|
||||||
* Quickly create advanced DApps using multiple contracts that can interact with decentralized infrastructure for storage and comunication.
|
|
||||||
|
|
Loading…
Reference in New Issue