Readme Updates, Include Whitepapers, Borrow language from Website

README.md

@@ -1,14 +1,61 @@
 NuCypher
 ========
+*A proxy re-encryption network to empower privacy in decentralized systems*
+
+- Website https://www.nucypher.com/
+- GitHub https://www.gihub.com/nucypher/nucypher
+
 
 .. image:: https://circleci.com/gh/nucypher/nucypher/tree/master.svg?style=svg
     :target: https://circleci.com/gh/nucypher/nucypher/tree/master
 
+.. image:: https://coveralls.io/repos/github/nucypher/nucypher/badge.svg?branch=master
+    :target: https://coveralls.io/github/nucypher/nucypher?branch=master
+
+
+
+NuCypher Proxy Re-encryption Network
+-------------------------------------
+
+1. Alice, the data owner, encrypts data with her public key and uploads it to IPFS, Swarm, S3, or any supported storage layer.
+To delegate access to valid recipients, she creates and uploads re-encryption keys to the NuCypher network.
+
+
+2. Ursula, a miner, receives the re-encryption keys and stands ready to re-key data.
+She provides this service in exchange for payment in fees and block rewards.
+The NuCypher network and the storage layer never have access to Alice's plaintext data.
+
+
+3. Bob, a valid recipient, sends an access request to the NuCypher network.
+If a valid re-encryption key exists and specified conditions are met,
+the data is re-keyed to his public key and he is able to decrypt with his private key.
+
+
+Whitepapers
+-----------
+
+**Network**
+
+https://www.nucypher.com/static/whitepapers/english.pdf
+
+*NuCypher - A proxy re-encryption network to empower privacy in decentralized systems*
+*Michael Egorov, David Nuñez, and MacLane Wilkison - NuCypher*
+
+
+**Economics**
+
+https://www.nucypher.com/static/whitepapers/mining-paper.pdf
+
+*NuCypher - Mining & Staking Economics*
+*Michael Egorov, MacLane Wilkison - NuCypher*
+
+
 .. toctree::
    :maxdepth: 2
 
-About
-------
+
+Architecture
+------------
 
 .. toctree::
    :maxdepth: 1
@@ -26,6 +73,8 @@ Guides
    guides/quickstart
    guides/federated_testnet_guide
    guides/installation_guide
+   guides/contribution_guide
+
 
 Demos
 -----
@@ -37,6 +86,22 @@ Demos
    demos/finnegans_wake_demo
    demos/heartbeat_demo
 
+
+API
+---
+
+.. toctree::
+   :maxdepth: 2
+
+   api/characters
+   api/config
+   api/crypto
+   api/keyring
+   api/keystore
+   api/network
+   api/policy
+
+
 Release Notes
 -------------
 
@@ -45,3 +110,9 @@ Release Notes
 
    release_notes/genesis_release
 
+
+Indices and Tables
+==================
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/conf.py

@@ -12,9 +12,9 @@
 # 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.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
 
 
 # -- Project information -----------------------------------------------------
@@ -46,6 +46,7 @@ extensions = [
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
+    'sphinx.ext.napoleon',
     'sphinx.ext.mathjax',
     'sphinx.ext.viewcode',
 ]
@@ -158,7 +159,7 @@ man_pages = [
 #  dir menu entry, description, category)
 texinfo_documents = [
     (master_doc, 'NuCypher', 'NuCypher Documentation',
-     author, 'NuCypher', 'One line description of project.',
+     author, 'NuCypher', 'A proxy re-encryption network to empower privacy in decentralized systems.',
      'Miscellaneous'),
 ]
 
@@ -190,8 +191,15 @@ intersphinx_mapping = {'https://docs.python.org/': None}
 
 # -- Options for todo extension ----------------------------------------------
 
+
+def remove_module_docstring(app, what, name, obj, options, lines):
+    if what == "module":
+        del lines[:]
+
+
 # If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = True
+todo_include_todos = False
+
 
 def setup(app):
     github_doc_root = 'https://github.com/nucypher/nucypher/tree/master/docs'
@@ -202,3 +210,4 @@ def setup(app):
             'auto_toc_tree_section': 'Contents',
             }, True)
     app.add_transform(AutoStructify)
+    app.connect("autodoc-process-docstring", remove_module_docstring)