From 77f0a3dca97db65cc4e95ec2ce2f00efe90dc38b Mon Sep 17 00:00:00 2001
From: Neil Booth <kyuupichan@gmail.com>
Date: Thu, 8 Mar 2018 17:11:41 +0800
Subject: [PATCH] Documentation updates

---
 docs/AUTHORS              |  3 ---
 docs/authors.rst          | 16 ++++++++++++++++
 docs/conf.py              | 12 ++++++------
 docs/index.rst            | 26 +++++++++++++++++++++-----
 docs/protocol-changes.rst |  2 ++
 docs/protocol-methods.rst |  4 ++--
 6 files changed, 47 insertions(+), 16 deletions(-)
 delete mode 100644 docs/AUTHORS
 create mode 100644 docs/authors.rst

diff --git a/docs/AUTHORS b/docs/AUTHORS
deleted file mode 100644
index 09871ce..0000000
--- a/docs/AUTHORS
+++ /dev/null
@@ -1,3 +0,0 @@
-Neil Booth: creator and maintainer
-Johann Bauer: backend DB abstraction
-John Jegutanis: alt-chain integrations
\ No newline at end of file
diff --git a/docs/authors.rst b/docs/authors.rst
new file mode 100644
index 0000000..ee20e39
--- /dev/null
+++ b/docs/authors.rst
@@ -0,0 +1,16 @@
+.. _Authors:
+
+Authors
+=======
+
+* Neil Booth
+
+  Creator and maintainer.
+
+* Johann Bauer
+
+  Backend DB abstraction.
+
+* John Jegutanis
+
+  Alt-chain integrations.
diff --git a/docs/conf.py b/docs/conf.py
index 46487af..a34fea7 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -11,11 +11,11 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # 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('..'))
+from server.version import VERSION
 
 # -- Project information -----------------------------------------------------
 
@@ -24,9 +24,9 @@ copyright = '2016-2018, Neil Booth'
 author = 'Neil Booth'
 
 # The short X.Y version
-version = ''
+version = VERSION.split()[-1]
 # The full version, including alpha/beta/rc tags
-release = '1.2.1'
+release = VERSION
 
 
 # -- General configuration ---------------------------------------------------
diff --git a/docs/index.rst b/docs/index.rst
index 760a688..2b849bf 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -9,14 +9,28 @@ ElectrumX
 
 A reimplementation of Electrum-Server for a future with bigger blocks.
 
-  :Licence: MIT
-  :Language: Python (>= 3.6)
-  :Author: Neil Booth
+The current version is |release|.
 
 Source Code
 ===========
 
-See the respository on `github <https://github.com/kyuupichan/electrumx/>`_.
+The project is hosted on `GitHub
+<https://github.com/kyuupichan/electrumx/>`_.  and uses `Travis
+<https://travis-ci.org/kyuupichan/electrumx>`_ for Continuous
+Integration.
+
+Please submit an issue on the `bug tracker
+<https://github.com/kyuupichan/electrumx/issues>`_ if you have found a
+bug or have a suggestion to improve the server.
+
+Authors and License
+===================
+
+Neil Booth wrote the vast majority of the code; see :ref:`Authors`.
+Python version at least 3.6 is required.
+
+The code is released under the `MIT Licence
+<https://github.com/kyuupichan/electrumx/LICENCE>`_.
 
 Getting Started
 ===============
@@ -30,6 +44,8 @@ available .
 .. _installer: https://github.com/bauerj/electrumx-installer
 .. _Dockerfile: https://github.com/lukechilds/docker-electrumx
 
+Documentation
+=============
 
 .. toctree::
 
@@ -41,7 +57,7 @@ available .
    PEER_DISCOVERY
    RPC-INTERFACE
    ARCHITECTURE
-
+   authors
 
 Indices and tables
 ==================
diff --git a/docs/protocol-changes.rst b/docs/protocol-changes.rst
index 0d7696e..faa96ac 100644
--- a/docs/protocol-changes.rst
+++ b/docs/protocol-changes.rst
@@ -56,6 +56,8 @@ Changes
     *verbose*.
   * :func:`blockchain.headers.subscribe` now has an optional parameter
     *raw*.
+  * :func:`server.vesrion` should not be used for "ping" functionality;
+    use the new :func:`server.ping` method instead.
 
 New methods
 -----------
diff --git a/docs/protocol-methods.rst b/docs/protocol-methods.rst
index d7ebe89..f09a821 100644
--- a/docs/protocol-methods.rst
+++ b/docs/protocol-methods.rst
@@ -957,8 +957,8 @@ Return a list of features and services supported by the server.
 server.peers.subscribe
 ----------------------
 
-  Return a list of peer servers.  Despite the name this is not a
-  subscription and the server must send no notifications.
+Return a list of peer servers.  Despite the name this is not a
+subscription and the server must send no notifications.
 
 **Signature**