New Sphinx theme and better docs

documentation/source/conf.py

@@ -1,7 +1,7 @@
 author = 'decentral1se'
 copyright = '2019, decentral1se'
 html_static_path = ['_static']
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 master_doc = 'index'
 project = 'hypercore-crypto'
 templates_path = ['_templates']

documentation/source/example.rst

@@ -0,0 +1,13 @@
+.. _example:
+
+*******
+Example
+*******
+
+.. code-block:: python
+
+    from hypercore_crypto import key_pair, sign, verify
+
+    public_key, secret_key = key_pair()
+    signature = sign(b'hello world', secret_key)
+    verify(message, signature, public_key)

documentation/source/index.rst

@@ -1,12 +1,13 @@
 .. include:: ../../README.rst
-  :end-before: _documentation
-
-Table of Contents
-*****************
+   :end-before: _documentation
 
 .. toctree::
+   :maxdepth: 1
+   :hidden:
 
    install
+   upgrade
+   example
    modules-api
    other-impls
    contribute

documentation/source/other-impls.rst

@@ -1,7 +1,11 @@
 .. _other-implementations:
 
+*********************
 Other Implementations
 *********************
 
-* https://github.com/mafintosh/hypercore-crypto
-* https://github.com/datcxx/hypercore-crypto
+* `mafintosh/hypercore-crypto`_
+* `datcxx/hypercore-crypto`_
+
+.. _mafintosh/hypercore-crypto: https://github.com/mafintosh/hypercore-crypto
+.. _datcxx/hypercore-crypto: https://github.com/datcxx/hypercore-crypto

documentation/source/upgrade.rst

@@ -0,0 +1,7 @@
+*******
+Upgrade
+*******
+
+.. code-block:: bash
+
+    $ pip install --upgrade hypercore-crypto