Added blank pages. Set structure. Removed Solidity Highlighter

Removed Solidity Highlighter until we determine if we need it. Added all pages and structure of RST files.
ethereum · Jan 25, 2016 · b02ea5c · b02ea5c
1 parent 75f46a5
commit b02ea5c
Show file tree

Hide file tree

Showing 40 changed files with 165 additions and 124 deletions.
diff --git a/source/conf.py b/source/conf.py
@@ -22,10 +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())
+# 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'
@@ -102,7 +102,7 @@ def setup(sphinx):
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
-highlight_language = 'Solidity'
+# 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
diff --git a/source/developing-on-ethereum.rst b/source/developing-on-ethereum.rst
diff --git a/source/index.rst b/source/index.rst
@@ -14,13 +14,12 @@ Contents
 .. 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
+   sections\introduction\introduction.rst
+   sections\ethereum-ecosystem\ethereum-ecosystem.rst
+   sections\using-ethereum-the-basics\using-ethereum-the-basics.rst
+   sections\contracts-and-transactions.rst
+   sections\developing-on-ethereum\developing-on-ethereum.rst
+   sections\frequently-asked-questions\frequently-asked-questions.rst
 
 
 
@@ -68,6 +67,10 @@ Using Ethereum: The Basics
     * ARM
     * Binaries
     * Source Installation
+  - Connecting to the Network
+    * Syncing vs Fast Syncing
+    * Light Client Network Connectivity
+    * NAT and Peer Discovery
   - Creating an Account
     * Using Console
     * Using EthKey
@@ -80,8 +83,8 @@ Using Ethereum: The Basics
     * 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
+	  * Importing Wallets [including pre-sale wallets]
+	  * Online wallets, Paper Wallets, and Cold Storage
   - Ether
     * What is Ether?
     * [Table of Sub Units]
@@ -122,7 +125,7 @@ Contracts and Transactions
 Developing on Ethereum
   - Developer Tools
     * IDEs/Frameworks
-    * High Level Languages
+    * Solidity Contract Language Resources
     * Other Tools
   - DApp Development
     * Web3

diff --git a/source/base-layer-services.rst → .../accessing-contracts-and-transactions.rst b/source/base-layer-services.rst → .../accessing-contracts-and-transactions.rst
diff --git a/source/block-explorers.rst → ...ns/account-types-gas-and-transactions.rst b/source/block-explorers.rst → ...ns/account-types-gas-and-transactions.rst
diff --git a/source/sections/contracts-and-transactions/contracts-and-transactions.rst b/source/sections/contracts-and-transactions/contracts-and-transactions.rst
@@ -0,0 +1,36 @@
+###################
+Contracts and Transactions
+###################
+
+.. toctree::
+   :maxdepth: 2
+   account-types-gas-and-transactions.rst
+   contracts.rst
+   accessing-contracts-and-transactions.rst
+
+
+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]
diff --git a/source/client-implimentations.rst → .../contracts-and-transactions/contracts.rst b/source/client-implimentations.rst → .../contracts-and-transactions/contracts.rst
diff --git a/source/dapps.rst → ...veloping-on-ethereum/dapp-development.rst b/source/dapps.rst → ...veloping-on-ethereum/dapp-development.rst
diff --git a/source/disclaimer.rst → ...eveloping-on-ethereum/developer-tools.rst b/source/disclaimer.rst → ...eveloping-on-ethereum/developer-tools.rst
diff --git a/source/sections/developing-on-ethereum/developing-on-ethereum.rst b/source/sections/developing-on-ethereum/developing-on-ethereum.rst
@@ -0,0 +1,25 @@
+###################
+Developing on Ethereum
+###################
+
+.. toctree::
+   :maxdepth: 2
+   developer-tools.rst
+   dapp-development.rst
+   web3-base-layer-services.rst
+
+
+Developing on Ethereum
+  - Developer Tools
+    * IDEs/Frameworks
+    * Solidity Contract Language Resources
+    * Other Tools
+  - DApp Development
+    * Web3
+    * Conntecting to Morden Testnet
+    * Setting Up Private Testnet
+  - Web3 Base Layer Services
+    * SWARM
+    * Whisper
+    * Name Registry
+    * Contract Registry
diff --git a/source/evm-compilers.rst → ...-on-ethereum/web3-base-layer-services.rst b/source/evm-compilers.rst → ...-on-ethereum/web3-base-layer-services.rst
diff --git a/source/exchanges.rst → ...thereum-ecosystem/base-layer-services.rst b/source/exchanges.rst → ...thereum-ecosystem/base-layer-services.rst
diff --git a/source/glossary.rst → ...ns/ethereum-ecosystem/block-explorers.rst b/source/glossary.rst → ...ns/ethereum-ecosystem/block-explorers.rst
diff --git a/source/history-of-ethereum.rst → ...reum-ecosystem/client-implimentations.rst b/source/history-of-ethereum.rst → ...reum-ecosystem/client-implimentations.rst
diff --git a/source/community.rst → ...sections/ethereum-ecosystem/community.rst b/source/community.rst → ...sections/ethereum-ecosystem/community.rst
diff --git a/source/mining-pools.rst → source/sections/ethereum-ecosystem/dapps.rst b/source/mining-pools.rst → source/sections/ethereum-ecosystem/dapps.rst
diff --git a/source/sections/ethereum-ecosystem/ethereum-ecosystem.rst b/source/sections/ethereum-ecosystem/ethereum-ecosystem.rst
@@ -0,0 +1,32 @@
+###################
+Ethereum Ecosystem
+###################
+
+.. toctree::
+   :maxdepth: 2
+
+   ethereum-network-stats.rst
+   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
+
+   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
diff --git a/source/ethereum-ecosystem.rst → ...reum-ecosystem/ethereum-network-stats.rst b/source/ethereum-ecosystem.rst → ...reum-ecosystem/ethereum-network-stats.rst
diff --git a/source/miscellaneous-tools.rst → ...ions/ethereum-ecosystem/evm-compilers.rst b/source/miscellaneous-tools.rst → ...ions/ethereum-ecosystem/evm-compilers.rst
diff --git a/source/solidity-in-depth.rst → ...sections/ethereum-ecosystem/exchanges.rst b/source/solidity-in-depth.rst → ...sections/ethereum-ecosystem/exchanges.rst
diff --git a/source/the-homestead-release.rst → ...tions/ethereum-ecosystem/mining-pools.rst b/source/the-homestead-release.rst → ...tions/ethereum-ecosystem/mining-pools.rst
diff --git a/source/what-is-ethereum.rst → ...thereum-ecosystem/miscellaneous-tools.rst b/source/what-is-ethereum.rst → ...thereum-ecosystem/miscellaneous-tools.rst
diff --git a/source/frequently-asked-questions.rst → ...-questions/frequently-asked-questions.rst b/source/frequently-asked-questions.rst → ...-questions/frequently-asked-questions.rst
@@ -2,6 +2,3 @@
 Frequently Asked Questions
 ###################
 
-.. toctree::
-   :maxdepth: 2
-
diff --git a/source/sections/introduction/disclaimer.rst b/source/sections/introduction/disclaimer.rst
diff --git a/source/sections/introduction/glossary.rst b/source/sections/introduction/glossary.rst
diff --git a/source/sections/introduction/history-of-ethereum.rst b/source/sections/introduction/history-of-ethereum.rst
diff --git a/source/introduction.rst → ...ce/sections/introduction/introduction.rst b/source/introduction.rst → ...ce/sections/introduction/introduction.rst
diff --git a/source/sections/introduction/the-homestead-release.rst b/source/sections/introduction/the-homestead-release.rst
diff --git a/source/sections/introduction/what-is-ethereum.rst b/source/sections/introduction/what-is-ethereum.rst
diff --git a/source/sections/using-ethereum-the-basics/account-management.rst b/source/sections/using-ethereum-the-basics/account-management.rst
diff --git a/source/sections/using-ethereum-the-basics/backup-import-accounts.rst b/source/sections/using-ethereum-the-basics/backup-import-accounts.rst
diff --git a/source/sections/using-ethereum-the-basics/connecting-to-the-network.rst b/source/sections/using-ethereum-the-basics/connecting-to-the-network.rst
diff --git a/source/sections/using-ethereum-the-basics/creating-an-account.rst b/source/sections/using-ethereum-the-basics/creating-an-account.rst
diff --git a/source/sections/using-ethereum-the-basics/ether.rst b/source/sections/using-ethereum-the-basics/ether.rst
diff --git a/source/sections/using-ethereum-the-basics/installing-a-client.rst b/source/sections/using-ethereum-the-basics/installing-a-client.rst
diff --git a/source/sections/using-ethereum-the-basics/mining.rst b/source/sections/using-ethereum-the-basics/mining.rst
diff --git a/source/sections/using-ethereum-the-basics/using-ethereum-the-basics.rst b/source/sections/using-ethereum-the-basics/using-ethereum-the-basics.rst
@@ -0,0 +1,54 @@
+###################
+Using Ethereum: The Basics
+###################
+
+.. toctree::
+   :maxdepth: 2
+
+   installing-a-client.rst
+   connecting-to-the-network.rst
+   creating-an-account.rst
+   account-management.rst
+   backup-import-accounts.rst
+   ether.rst
+   mining.rst
+
+
+Using Ethereum: The Basics
+  - Installing a Client
+    * Linux
+    * Windows
+    * Mac
+    * iOs
+    * Android
+    * Raspberry Pi
+    * ARM
+    * Binaries
+    * Source Installation
+  - Connecting to the Network
+    * Syncing vs Fast Syncing
+    * Light Client Network Connectivity
+    * NAT and Peer Discovery
+  - 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]
diff --git a/source/using-ethereum-the-basics.rst b/source/using-ethereum-the-basics.rst
diff --git a/source/utils/SolidityLexer.py b/source/utils/SolidityLexer.py