Document the jsonrpc module

README.rst

@@ -1,10 +1,23 @@
 .. image:: https://badge.fury.io/py/aiorpcX.png
     :target: http://badge.fury.io/py/aiorpcX
-
 .. image:: https://travis-ci.org/kyuupichan/aiorpcX.png?branch=master
     :target: https://travis-ci.org/kyuupichan/aiorpcX
-
 .. image:: https://coveralls.io/repos/github/kyuupichan/aiorpcX/badge.svg
     :target: https://coveralls.io/github/kyuupichan/aiorpcX
 
-To come...
+=======
+aiorpcX
+=======
+
+A generic `asyncio <https://docs.python.org/3/library/asyncio.html>`_
+library implementation of RPC suitable for an application that is a
+client, server or both.
+
+  :Licence: MIT
+  :Language: Python (>= 3.6)
+  :Author: Neil Booth
+
+Documentation
+=============
+
+See `readthedocs <https://aiorpcX.readthedocs.io/>`_.

aiorpcx/__init__.py

@@ -4,11 +4,12 @@
 from .socks import *
 from .util import *
 
+_version = (0, 4, 3)
+_version_str = '.'.join(str(part) for part in _version)
+
 __all__ = (framing.__all__ +
            jsonrpc.__all__ +
            rpc.__all__ +
            socks.__all__ +
-           util.__all__)
-
-_version = (0, 4, 3)
-_version_str = '.'.join(str(part) for part in _version)
+           util.__all__ +
+           (_version, _version_str))

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = aiorpcX
+SOURCEDIR     = .
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,157 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/stable/config
+
+# -- Path setup --------------------------------------------------------------
+
+# 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 aiorpcx
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'aiorpcX'
+copyright = '2018, Neil Booth'
+author = 'Neil Booth'
+
+# The short X.Y version
+version = aiorpcx._version_str
+# The full version, including alpha/beta/rc tags
+release = version
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path .
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'aiorpcXdoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'aiorpcX.tex', 'aiorpcX Documentation',
+     'Neil Booth', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'aiorpcx', 'aiorpcX Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'aiorpcX', 'aiorpcX Documentation',
+     author, 'aiorpcX', 'One line description of project.',
+     'Miscellaneous'),
+]

docs/index.rst

@@ -0,0 +1,56 @@
+=======
+aiorpcX
+=======
+
+.. image:: https://badge.fury.io/py/aiorpcX.png
+    :target: http://badge.fury.io/py/aiorpcX
+.. image:: https://travis-ci.org/kyuupichan/aiorpcX.png?branch=master
+    :target: https://travis-ci.org/kyuupichan/aiorpcX
+.. image:: https://coveralls.io/repos/github/kyuupichan/aiorpcX/badge.svg
+    :target: https://coveralls.io/github/kyuupichan/aiorpcX
+
+A generic asyncio library implementation of RPC suitable for an
+application that is a client, server or both.
+
+The package includes a module with full coverage of `JSON RPC
+<http://www.jsonrpc.org/>`_ versions 1.0 and 2.0, JSON RPC protocol
+auto-detection, and arbitrary message framing.  It also comes with a
+SOCKS proxy client.
+
+The current version is |release|.
+
+Source Code
+===========
+
+The project is hosted on `GitHub
+<https://github.com/kyuupichan/aiorpcX/>`_.  and uses `Travis
+<https://travis-ci.org/kyuupichan/aiorpcX>`_ for Continuous
+Integration.
+
+Python version at least 3.6 is required.
+
+Please submit an issue on the `bug tracker
+<https://github.com/kyuupichan/aiorpcX/issues>`_ if you have found a
+bug or have a suggestion to improve the library.
+
+Authors and License
+===================
+
+Neil Booth wrote the code, which is derived from ElectrumX's original
+JSON RPC handling.
+
+The code is released under the `MIT Licence
+<https://github.com/kyuupichan/aiorpcX/LICENCE>`_.
+
+Documentation
+=============
+
+.. toctree::
+
+   json-rpc
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`