Structure and conf.py changes

Set-up Structure of Docs and created some pages
ethereum · Jan 18, 2016 · 75f46a5 · 75f46a5
1 parent 06428bc
commit 75f46a5
Show file tree

Hide file tree

Showing 24 changed files with 275 additions and 3 deletions.
diff --git a/source/base-layer-services.rst b/source/base-layer-services.rst
diff --git a/source/block-explorers.rst b/source/block-explorers.rst
diff --git a/source/client-implimentations.rst b/source/client-implimentations.rst
diff --git a/source/community.rst b/source/community.rst
@@ -0,0 +1,9 @@
+
+Fora [github, wiki, gitter, reddit, forum, stackoverflow]
+=============
+
+Hubs
+=============
+
+Meetups
+=============
diff --git a/source/conf.py b/source/conf.py
@@ -22,6 +22,10 @@
 #sys.path.insert(0, os.path.abspath('.'))
 
 # -- General configuration ------------------------------------------------
+def setup(sphinx):
+    sys.path.insert(0, os.path.abspath('./utils'))
+    from SolidityLexer import SolidityLexer
+    sphinx.add_lexer('Solidity', SolidityLexer())
 
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
@@ -78,7 +82,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = []
+exclude_patterns = ['_build']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -98,6 +102,8 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
+highlight_language = 'Solidity'
+
 # A list of ignored prefixes for module index sorting.
 #modindex_common_prefix = []
 

diff --git a/source/contracts-and-transactions.rst b/source/contracts-and-transactions.rst
@@ -0,0 +1,7 @@
+###################
+Contracts and Transactions
+###################
+
+.. toctree::
+   :maxdepth: 2
+
diff --git a/source/dapps.rst b/source/dapps.rst
diff --git a/source/developing-on-ethereum.rst b/source/developing-on-ethereum.rst
@@ -0,0 +1,7 @@
+###################
+Developing on Ethereum
+###################
+
+.. toctree::
+   :maxdepth: 2
+
diff --git a/source/disclaimer.rst b/source/disclaimer.rst
diff --git a/source/ethereum-ecosystem.rst b/source/ethereum-ecosystem.rst
@@ -0,0 +1,16 @@
+###################
+Ethereum Ecosystem
+###################
+
+.. toctree::
+   :maxdepth: 2
+
+   client-implimentations.rst
+   evm-compilers.rst
+   block-explorers.rst
+   miscellaneous-tools.rst
+   exchanges.rst
+   mining-pools.rst
+   base-layer-services.rst
+   dapps.rst
+   community.rst
diff --git a/source/evm-compilers.rst b/source/evm-compilers.rst
diff --git a/source/exchanges.rst b/source/exchanges.rst
diff --git a/source/frequently-asked-questions.rst b/source/frequently-asked-questions.rst
@@ -0,0 +1,7 @@
+###################
+Frequently Asked Questions
+###################
+
+.. toctree::
+   :maxdepth: 2
+
diff --git a/source/glossary.rst b/source/glossary.rst
diff --git a/source/history-of-ethereum.rst b/source/history-of-ethereum.rst
diff --git a/source/index.rst b/source/index.rst
@@ -3,14 +3,25 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to homestead guide's documentation!
+Welcome to Ethereum Homestead Documentation!
 ===========================================
 
-Contents:
+Contents
+========
+
+:ref:`Keyword Index <genindex>`, :ref:`Search Page <search>`
 
 .. toctree::
    :maxdepth: 2
 
+   introduction.rst
+   ethereum-ecosystem.rst
+   using-ethereum-the-basics.rst
+   solidity-in-depth.rst
+   contracts-and-transactions.rst
+   developing-on-ethereum.rst
+   frequently-asked-questions.rst
+
 
 
 Indices and tables
@@ -20,3 +31,107 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
+
+Structure of Guide
+==================
+
+Introduction
+  - What is Ethereum?
+  - The Homestead Release
+  - History of Ethereum[focus on brevity vs completeness with links to outside resources]
+  - Disclaimer [security/legal warning, etc.]
+  - Glossary [of Common Ethereum Terms]
+
+Ethereum Ecosystem
+  - Ethereum Network Stats
+  - Client Implementations
+  - EVM Compilers
+  - Block Explorers
+  - Miscellaneous Tools
+  - Exchanges
+  - Mining Pools
+  - Base Layer Services
+  - DApps
+  - Community
+    * Fora [github, wiki, gitter, reddit, forum, stackoverflow]
+    * Hubs
+    * Meetups
+
+Using Ethereum: The Basics
+  - Installing a Client
+    * Linux
+    * Windows
+    * Mac
+    * iOs
+    * Android
+    * Raspberry Pi
+    * ARM
+    * Binaries
+    * Source Installation
+  - Creating an Account
+    * Using Console
+    * Using EthKey
+    * Using Mist
+    * Using RPC
+  - Account Management
+    * What are keys, wallets, and accounts?
+    * Keys
+    * Wallets
+    * Accounts (EOA) [Externally Owned Accounts are referenced here. make sure to differentiate from contract accounts that are mentioned later in the guide]
+  - Backup/Import Accounts
+  	* Backing Up Wallets
+	* Importing Wallets [including pre-sale wallets]
+	* Online wallets, Paper Wallets and Cold Storage
+  - Ether
+    * What is Ether?
+    * [Table of Sub Units]
+    * Getting Ether [Will point to mining and exchanges pages with explanation of both]
+    * Sending Ether
+  - Mining
+    * CPU Mining
+    * GPU Mining
+    * Pool Mining [Will link to mining pools list in ecosystem section]
+
+Contracts and Transactions
+  - Account Types, Gas, and Transactions
+    * EOA vs Contract Accounts
+    * What is a Transaction? [in the context of Ethereum]
+    * What is Gas? [explain that it is the fuel for Ethereum transactions]
+    * Estimating Gas
+    * Lifecycle of a Transaction
+    * Transaction Pool
+    * Signing Transactions Offline
+  - Contracts
+    * What is a Contract?
+    * Steps to Creating a Contract
+    * Write the Contract [Point to solidity docs, but give small example of contract]
+    * Compile the Contract [use same example]
+    * Create and Deploy the Contract
+    * Interacting with a Contract
+    * Console
+    * web3.js
+    * RPC
+  - Accessing Contracts and Transactions
+    * APIs
+    * Console
+    * RPC
+    * Javascript
+    * [Link to blockchain explorers page]
+
+
+Developing on Ethereum
+  - Developer Tools
+    * IDEs/Frameworks
+    * High Level Languages
+    * Other Tools
+  - DApp Development
+    * Web3
+    * Conntecting to Morden Testnet
+    * Setting Up Private Testnet
+  - Web3 Base Layer Services
+    * SWARM
+    * Whisper
+    * Name Registry
+    * Contract Registry
+
+ Frequently Asked Questions
diff --git a/source/introduction.rst b/source/introduction.rst
@@ -0,0 +1,13 @@
+###################
+Introduction
+###################
+
+.. toctree::
+   :maxdepth: 2
+
+   what-is-ethereum.rst
+   the-homestead-release.rst
+   solidity-in-depth.rst
+   history-of-ethereum.rst
+   disclaimer.rst
+   glossary.rst
diff --git a/source/mining-pools.rst b/source/mining-pools.rst
diff --git a/source/miscellaneous-tools.rst b/source/miscellaneous-tools.rst
diff --git a/source/solidity-in-depth.rst b/source/solidity-in-depth.rst
diff --git a/source/the-homestead-release.rst b/source/the-homestead-release.rst
diff --git a/source/using-ethereum-the-basics.rst b/source/using-ethereum-the-basics.rst
@@ -0,0 +1,7 @@
+###################
+Using Ethereum: The Basics
+###################
+
+.. toctree::
+   :maxdepth: 2
+
diff --git a/source/utils/SolidityLexer.py b/source/utils/SolidityLexer.py
@@ -0,0 +1,85 @@
+# -*- coding: utf-8 -*-
+
+import re
+import copy
+
+from pygments.lexer import RegexLexer, ExtendedRegexLexer, bygroups, using, \
+     include, this
+from pygments.token import Text, Comment, Operator, Keyword, Name, String, \
+     Number, Other, Punctuation, Literal
+
+__all__ = ['SolidityLexer']
+
+class SolidityLexer(RegexLexer):
+    name = "Solidity"
+    aliases = ['sol', 'solidity']
+    filenames = ['*.sol']
+    mimetypes = []
+    flags = re.DOTALL
+    tokens = {
+        'commentsandwhitespace': [
+            (r'\s+', Text),
+            (r'<!--', Comment),
+            (r'///', Comment.Special, 'docstringsingle'),
+            (r'//.*?\n', Comment.Single),
+            (r'/\*\*', Comment.Special, 'docstringmulti'),
+            (r'/\*.*?\*/', Comment.Multiline)
+        ],
+        'natspec': [
+            (r'@author|@dev|@notice|@return|@param|@why3|@title', Keyword),
+            (r'.[^@*\n]*?', Comment.Special)
+        ],
+        'docstringsingle': [
+            (r'\n', Comment.Special, '#pop'),
+            include('natspec')
+        ],
+        'docstringmulti': [
+            (r'\*/', Comment.Special, '#pop'),
+            include('natspec')
+        ],
+        'slashstartsregex': [
+            include('commentsandwhitespace'),
+            (r'/(\\.|[^[/\\\n]|\[(\\.|[^\]\\\n])*])+/'
+             r'([gim]+\b|\B)', String.Regex, '#pop'),
+            (r'(?=/)', Text, ('#pop', 'badregex')),
+            (r'', Text, '#pop')
+        ],
+        'badregex': [
+            (r'\n', Text, '#pop')
+        ],
+        'root': [
+            (r'^(?=\s|/|<!--)', Text, 'slashstartsregex'),
+            include('commentsandwhitespace'),
+            (r'\+\+|--|\*\*|~|&&|\?|:|\|\||\\(?=\n)|'
+             r'(<<|>>>?|==?|!=?|[-<>+*%&\|\^/])=?', Operator, 'slashstartsregex'),
+            (r'[{(\[;,]', Punctuation, 'slashstartsregex'),
+            (r'[})\].]', Punctuation),
+            (r'(for|in|while|do|break|return|continue|switch|case|default|if|else|'
+             r'throw|try|catch|finally|new|delete|typeof|instanceof|void|'
+             r'this|import|mapping|returns|private|public|external|internal|'
+             r'constant|memory|storage)\b', Keyword, 'slashstartsregex'),
+            (r'(var|let|with|function|event|modifier|struct|enum|contract)\b', Keyword.Declaration, 'slashstartsregex'),
+            (r'(bytes|string|address|uint|int|bool|byte|' +
+             '|'.join(
+                 ['uint%d' % (i + 8) for i in range(0, 256, 8)] +
+                 ['int%d' % (i + 8) for i in range(0, 256, 8)] +
+                 ['bytes%d' % (i + 1) for i in range(0, 32)]
+             ) + r')\b', Keyword.Type, 'slashstartsregex'),
+            (r'(abstract|boolean|byte|char|class|const|debugger|double|enum|export|'
+             r'extends|final|float|goto|implements|int|interface|long|native|'
+             r'package|private|protected|public|short|static|super|synchronized|throws|'
+             r'transient|volatile)\b', Keyword.Reserved),
+            (r'(true|false|null|NaN|Infinity|undefined)\b', Keyword.Constant),
+            (r'(Array|Boolean|Date|Error|Function|Math|netscape|'
+             r'Number|Object|Packages|RegExp|String|sun|decodeURI|'
+             r'decodeURIComponent|encodeURI|encodeURIComponent|'
+             r'Error|eval|isFinite|isNaN|parseFloat|parseInt|document|this|'
+             r'window)\b', Name.Builtin),
+            (r'[$a-zA-Z_][a-zA-Z0-9_]*', Name.Other),
+            (r'[0-9][0-9]*\.[0-9]+([eE][0-9]+)?[fd]?', Number.Float),
+            (r'0x[0-9a-fA-F]+', Number.Hex),
+            (r'[0-9]+', Number.Integer),
+            (r'"(\\\\|\\"|[^"])*"', String.Double),
+            (r"'(\\\\|\\'|[^'])*'", String.Single),
+        ]
+    }
diff --git a/source/what-is-ethereum.rst b/source/what-is-ethereum.rst