added docs (#5)

.gitignore

@@ -2,6 +2,7 @@ venv3/
 venv/
 venv-cpp/
 venv-py/
+venv-doc/
 .mypy_cache/
 .idea/
 *.pyc

docs/.gitignore

@@ -0,0 +1,2 @@
+_build
+build

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+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,182 @@
+# -*- 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/master/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 mapry_meta
+
+# -- Project information -----------------------------------------------------
+
+project = mapry_meta.__title__
+copyright = mapry_meta.__copyright__
+author = mapry_meta.__author__
+description = mapry_meta.__description__
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = mapry_meta.__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 = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx_autodoc_typehints',
+    'sphinx_icontract'
+]
+
+# 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 = None
+
+
+# -- 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']
+
+# 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 = 'Maprydoc'
+
+
+# -- 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, '{}.tex'.format(project), '{} Documentation'.format(project),
+     author, '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, project, '{} Documentation'.format(project),
+     [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, project, '{} Documentation'.format(project),
+     author, project, description,
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------

docs/source/index.rst

@@ -0,0 +1,20 @@
+.. Mapry documentation master file, created by
+   sphinx-quickstart on Wed Jun  5 06:44:35 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Mapry's documentation!
+=================================
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents:
+
+    moduledoc/index
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/moduledoc/index.rst

@@ -0,0 +1,12 @@
+mapry Module
+============
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents:
+
+    mapry
+    mapry.parse
+    mapry.cpp.generate
+    mapry.py.generate
+    mapry.go.generate

docs/source/moduledoc/mapry.cpp.generate.rst

@@ -0,0 +1,29 @@
+mapry.cpp.generate
+==================
+
+.. automodule:: mapry.cpp.generate
+
+mapry.cpp.generate.types_header
+-------------------------------
+.. automodule:: mapry.cpp.generate.types_header
+    :members:
+
+mapry.cpp.generate.parse_header
+-------------------------------
+.. automodule:: mapry.cpp.generate.parse_header
+    :members:
+
+mapry.cpp.generate.parse_impl
+-----------------------------
+.. automodule:: mapry.cpp.generate.parse_impl
+    :members:
+
+mapry.cpp.generate.jsoncpp_header
+---------------------------------
+.. automodule:: mapry.cpp.generate.jsoncpp_header
+    :members:
+
+mapry.cpp.generate.jsoncpp_impl
+-------------------------------
+.. automodule:: mapry.cpp.generate.jsoncpp_impl
+    :members:

docs/source/moduledoc/mapry.go.generate.rst

@@ -0,0 +1,36 @@
+mapry.go.generate
+==================
+
+.. automodule:: mapry.go.generate
+
+mapry.go.generate.types
+-----------------------
+.. automodule:: mapry.go.generate.types
+    :members:
+
+mapry.go.generate.parse
+-----------------------
+.. automodule:: mapry.go.generate.parse
+    :members:
+
+mapry.go.generate.fromjsonable
+------------------------------
+.. automodule:: mapry.go.generate.fromjsonable
+    :members:
+
+mapry.go.generate.fromjsonable_test
+-----------------------------------
+.. automodule:: mapry.go.generate.fromjsonable_test
+    :members:
+
+
+mapry.go.generate.tojsonable
+----------------------------
+.. automodule:: mapry.go.generate.tojsonable
+    :members:
+
+
+mapry.go.generate.tojsonable_test
+---------------------------------
+.. automodule:: mapry.go.generate.tojsonable_test
+    :members:

docs/source/moduledoc/mapry.parse.rst

@@ -0,0 +1,5 @@
+mapry.parse
+===========
+
+.. automodule:: mapry.parse
+    :members:

docs/source/moduledoc/mapry.py.generate.rst

@@ -0,0 +1,24 @@
+mapry.py.generate
+==================
+
+.. automodule:: mapry.py.generate
+
+mapry.py.generate.types
+-----------------------
+.. automodule:: mapry.py.generate.types
+    :members:
+
+mapry.py.generate.parse
+-----------------------
+.. automodule:: mapry.py.generate.parse
+    :members:
+
+mapry.py.generate.fromjsonable
+------------------------------
+.. automodule:: mapry.py.generate.fromjsonable
+    :members:
+
+mapry.py.generate.tojsonable
+----------------------------
+.. automodule:: mapry.py.generate.tojsonable
+    :members:

docs/source/moduledoc/mapry.rst

@@ -0,0 +1,5 @@
+mapry
+=====
+
+.. automodule:: mapry
+    :members:

requirements-doc.txt

@@ -0,0 +1,4 @@
+sphinx>=1.7.7,<2
+sphinx-autodoc-typehints>=1.3.0,<2
+sphinx-icontract>=1.0.0
+sphinx-rtd-theme>=0.4.1,<1