Documentation updates
This commit is contained in:
parent
bfca87d13a
commit
77f0a3dca9
@ -1,3 +0,0 @@
|
||||
Neil Booth: creator and maintainer
|
||||
Johann Bauer: backend DB abstraction
|
||||
John Jegutanis: alt-chain integrations
|
||||
16
docs/authors.rst
Normal file
16
docs/authors.rst
Normal file
@ -0,0 +1,16 @@
|
||||
.. _Authors:
|
||||
|
||||
Authors
|
||||
=======
|
||||
|
||||
* Neil Booth
|
||||
|
||||
Creator and maintainer.
|
||||
|
||||
* Johann Bauer
|
||||
|
||||
Backend DB abstraction.
|
||||
|
||||
* John Jegutanis
|
||||
|
||||
Alt-chain integrations.
|
||||
12
docs/conf.py
12
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 ---------------------------------------------------
|
||||
|
||||
@ -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
|
||||
==================
|
||||
|
||||
@ -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
|
||||
-----------
|
||||
|
||||
@ -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**
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user