Project documentation using Sphinx (neovim#302)

Author: stsewd

.gitignore

@@ -8,3 +8,6 @@ dist/
 .cache
 .eggs
 .tox
+
+# Sphinx documentation
+docs/_build/

.readthedocs.yml

@@ -0,0 +1,6 @@
+build:
+  image: latest
+
+python:
+  version: 3.6
+  setup_py_install: true

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    = Neovim
+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/api/buffer.rst

@@ -0,0 +1,5 @@
+Buffer Class
+============
+
+.. autoclass:: neovim.api.Buffer
+   :members:

docs/api/nvim.rst

@@ -0,0 +1,7 @@
+Nvim Class
+==========
+
+An instance of this class is used by remote plugins.
+
+.. autoclass:: neovim.api.Nvim
+   :members:

docs/api/tabpage.rst

@@ -0,0 +1,5 @@
+Tabpage Class
+=============
+
+.. autoclass:: neovim.api.Tabpage
+   :members:

docs/api/window.rst

@@ -0,0 +1,5 @@
+Window Class
+============
+
+.. autoclass:: neovim.api.Window
+   :members:

docs/conf.py

@@ -0,0 +1,161 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Neovim documentation build configuration file, created by
+# sphinx-quickstart on Sat Feb  3 12:15:22 2018.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# 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 datetime
+
+
+# -- 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 = ['sphinx.ext.autodoc',
+    'sphinx.ext.viewcode']
+
+# 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'
+
+# General information about the project.
+project = 'Neovim Python Client'
+copyright = '2014 - {year}, Neovim'.format(
+    year=datetime.datetime.now().year
+)
+author = 'Neovim'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = ''
+# The full version, including alpha/beta/rc tags.
+release = ''
+
+# 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 patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- 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 = 'sphinx_rtd_theme'
+
+# 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']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Neovimdoc'
+
+
+# -- 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, 'Neovim.tex', 'Neovim Documentation',
+     'Neovim', '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, 'neovim', 'Neovim 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, 'Neovim', 'Neovim Documentation',
+     author, 'Neovim', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/development.rst

@@ -0,0 +1,89 @@
+Development
+===========
+
+If you change the code, you need to run::
+
+    pip2 install .
+    pip3 install .
+
+for the changes to have effect.
+Alternatively you could execute Neovim with the ``$PYTHONPATH`` environment variable::
+
+    PYTHONPATH=/path/to/python-client nvim
+
+But note this is not completely reliable,
+as installed packages can appear before ``$PYTHONPATH`` in the python search path.
+
+You need to rerun this command if you have changed the code,
+in order for Neovim to use it for the plugin host.
+
+To run the tests execute::
+
+    nosetests
+
+This will run the tests in an embedded instance of Neovim.
+If you want to test a different version than ``nvim`` in ``$PATH`` use::
+
+    NVIM_CHILD_ARGV='["/path/to/nvim", "-u", "NONE", "--embed"]' nosetests
+
+Alternatively, if you want to see the state of nvim, you could use::
+
+    export NVIM_LISTEN_ADDRESS=/tmp/nvimtest
+    xterm -e "nvim -u NONE"&
+    nosetests
+
+But note you need to restart Neovim every time you run the tests!
+Substitute your favorite terminal emulator for ``xterm``.
+
+Troubleshooting
+---------------
+
+You can run the plugin host in Neovim with logging enabled to debug errors::
+
+    NVIM_PYTHON_LOG_FILE=logfile NVIM_PYTHON_LOG_LEVEL=DEBUG nvim
+
+As more than one Python host process might be started,
+the log filenames take the pattern ``logfile_pyX_KIND``
+where ``X`` is the major python version (2 or 3)
+and ``KIND`` is either "rplugin" or "script" (for the ``:python[3]`` script interface).
+
+If the host cannot start at all,
+the error could be found in ``~/.nvimlog`` if ``nvim`` was compiled with logging.
+
+Usage through the Python REPL
+-----------------------------
+
+A number of different transports are supported,
+but the simplest way to get started is with the python REPL.
+First, start Neovim with a known address (or use the ``$NVIM_LISTEN_ADDRESS`` of a running instance)::
+
+    NVIM_LISTEN_ADDRESS=/tmp/nvim nvim
+
+In another terminal,
+connect a python REPL to Neovim (note that the API is similar to the one exposed by the `python-vim bridge`_):
+
+.. code-block:: python
+
+    >>> from neovim import attach
+    # Create a python API session attached to unix domain socket created above:
+    >>> nvim = attach('socket', path='/tmp/nvim')
+    # Now do some work. 
+    >>> buffer = nvim.current.buffer # Get the current buffer
+    >>> buffer[0] = 'replace first line'
+    >>> buffer[:] = ['replace whole buffer']
+    >>> nvim.command('vsplit')
+    >>> nvim.windows[1].width = 10
+    >>> nvim.vars['global_var'] = [1, 2, 3]
+    >>> nvim.eval('g:global_var')
+    [1, 2, 3]
+
+.. _`python-vim bridge`: http://vimdoc.sourceforge.net/htmldoc/if_pyth.html#python-vim
+
+You can embed Neovim into your python application instead of binding to a running neovim instance:
+
+.. code-block:: python
+
+    >>> from neovim import attach
+    >>> nvim = attach('child', argv=["/bin/env", "nvim", "--embed"])
+
+The tests can be consulted for more examples.

docs/index.rst

@@ -0,0 +1,36 @@
+Neovim Python Client
+====================
+
+Implements support for Python plugins in `Neovim`_.
+Also works as a library for connecting to and scripting Neovim processes through its msgpack-rpc API.
+
+.. _`Neovim`: http://neovim.io/
+
+.. toctree::
+   :caption: Getting started
+   :maxdepth: 2
+   
+   installation
+
+.. toctree::
+   :caption: Usage
+   :maxdepth: 2
+
+   usage/python-plugin-api
+   usage/remote-plugins
+
+.. toctree::
+   :caption: API documentation
+   :maxdepth: 2
+
+   plugin-decorators
+   api/nvim
+   api/buffer
+   api/window
+   api/tabpage
+
+.. toctree::
+   :caption: Development
+   :maxdepth: 2
+
+   development

docs/installation.rst

@@ -0,0 +1,36 @@
+Installation
+============
+
+The Neovim Python client supports Python 2.7, and 3.4 or later.
+
+Using pip
+---------
+
+You can install the package without being root by adding the ``--user`` flag::
+
+    pip2 install neovim
+    pip3 install neovim
+
+.. note::
+  
+    If you only use one of python2 or python3,
+    it is enough to install that version.
+
+If you follow Neovim master,
+make sure to upgrade the ``python-client`` when you upgrade Neovim::
+
+    pip2 install --upgrade neovim
+    pip3 install --upgrade neovim
+
+Install from source
+-------------------
+
+Clone the repository somewhere on your disk and enter to the repository:: 
+
+    git clone https://github.com/neovim/python-client.git
+    cd python-client
+
+Now you can install it on your system::
+
+    pip2 install .
+    pip3 install .