Sphinx configuration

Author: zilder

.gitignore

@@ -4,6 +4,8 @@
 .eggs/
 dist/
 build/
+docs/build/
+docs/source/_*
 
 env/
 venv/

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    = testgres
+SOURCEDIR     = source
+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/source/conf.py

@@ -0,0 +1,161 @@
+# -*- 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('../..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = u'testgres'
+copyright = u'2016-2018, Postgres Professional'
+author = u'Postgres Professional'
+
+# The short X.Y version
+version = u''
+# The full version, including alpha/beta/rc tags
+release = u'1.5'
+
+
+# -- 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',
+#]
+
+extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.napoleon']
+
+# 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 = 'testgresdoc'
+
+
+# -- 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, 'testgres.tex', u'testgres Documentation',
+     u'Postgres Professional', '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, 'testgres', u'testgres 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, 'testgres', u'testgres Documentation',
+     author, 'testgres', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Extension configuration -------------------------------------------------

docs/source/index.rst

@@ -0,0 +1,95 @@
+
+Testgres documentation
+======================
+
+Testgres is a PostgreSQL testing utility
+
+Installation
+============
+
+To install testgres, run:
+
+.. code-block:: bash
+
+    pip install testgres
+
+We encourage you to use ``virtualenv`` for your testing environment.
+
+Usage
+=====
+
+Environment
+-----------
+
+Note: by default testgres runs ``initdb``, ``pg_ctl``, ``psql`` provided by ``PATH``.
+
+There are several ways to specify a custom postgres installation:
+
+- export ``PG_CONFIG`` environment variable pointing to the ``pg_config`` executable;
+- export ``PG_BIN`` environment variable pointing to the directory with executable files.
+
+Example:
+
+.. code-block:: bash
+
+    export PG_BIN=$HOME/pg_10/bin
+    python my_tests.py
+
+Examples
+--------
+
+Here is an example of what you can do with ``testgres``:
+
+.. code-block:: python
+
+    # create a node with random name, port, etc
+    with testgres.get_new_node() as node:
+
+        # run inidb
+        node.init()
+
+        # start PostgreSQL
+        node.start()
+
+        # execute a query in a default DB
+        print(node.execute('select 1'))
+
+    # ... node stops and its files are about to be removed
+
+Backup & replication
+--------------------
+
+It's quite easy to create a backup and start a new replica:
+
+.. code-block:: python
+
+    with testgres.get_new_node('master') as master:
+        master.init().start()
+
+        # create a backup
+        with master.backup() as backup:
+
+            # create and start a new replica
+            replica = backup.spawn_replica('replica').start()
+
+            # catch up with master node
+            replica.catchup()
+
+            # execute a dummy query
+            print(replica.execute('postgres', 'select 1'))
+
+Modules
+=======
+
+.. toctree::
+   :maxdepth: 2
+
+   testgres
+
+
+.. Indices and tables
+.. ==================
+
+.. * :ref:`genindex`
+.. * :ref:`modindex`
+.. * :ref:`search`

docs/source/modules.rst

@@ -0,0 +1,7 @@
+testgres
+========
+
+.. toctree::
+   :maxdepth: 4
+
+   testgres