Merge branch 'master' into types

23 files changed, 234 insertions, 6 deletions

diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..d0c3cbf
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+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)
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..6247f7e
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF

+

+pushd %~dp0

+

+REM Command file for Sphinx documentation

+

+if "%SPHINXBUILD%" == "" (

+	set SPHINXBUILD=sphinx-build

+)

+set SOURCEDIR=source

+set BUILDDIR=build

+

+if "%1" == "" goto help

+

+%SPHINXBUILD% >NUL 2>NUL

+if errorlevel 9009 (

+	echo.

+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx

+	echo.installed, then set the SPHINXBUILD environment variable to point

+	echo.to the full path of the 'sphinx-build' executable. Alternatively you

+	echo.may add the Sphinx directory to PATH.

+	echo.

+	echo.If you don't have Sphinx installed, grab it from

+	echo.http://sphinx-doc.org/

+	exit /b 1

+)

+

+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

+goto end

+

+:help

+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

+

+:end

+popd

diff --git a/docs/source/conf.py b/docs/source/conf.py
new file mode 100644
index 0000000..3274a8a
--- /dev/null
+++ b/docs/source/conf.py
@@ -0,0 +1,73 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- 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 = 'lesana'
+copyright = "2020, Elena Grandi"
+author = "Elena ``of Valhalla''"
+
+# The full version, including alpha/beta/rc tags
+release = '0.6.0'
+# The major project version
+version = '0.6'
+
+# compatibility with sphinx 1.8 on buster
+master_doc = 'index'
+
+# -- General configuration ---------------------------------------------------
+
+# 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']
+
+# 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 = []
+
+
+# -- 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'
+
+# 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']
+
+man_pages = [
+    ('man/lesana-edit', 'lesana-edit', '', '', 1),
+    ('man/lesana-export', 'lesana-export', '', '', 1),
+    ('man/lesana-index', 'lesana-index', '', '', 1),
+    ('man/lesana-init', 'lesana-init', '', '', 1),
+    ('man/lesana-new', 'lesana-new', '', '', 1),
+    ('man/lesana-rm', 'lesana-rm', '', '', 1),
+    ('man/lesana', 'lesana', '', '', 1),
+    ('man/lesana-search', 'lesana-search', '', '', 1),
+    ('man/lesana-show', 'lesana-show', '', '', 1),
+]
diff --git a/docs/getting_started_command_line.rst b/docs/source/getting_started_command_line.rst
index d2e4378..0c4d507 100644
--- a/docs/getting_started_command_line.rst
+++ b/docs/source/getting_started_command_line.rst
@@ -1,5 +1,6 @@
+******************************
 Getting Started (Command Line)
-==============================
+******************************
 
 lesana can be used from the command line through the ``lesana`` command;
 for more details run ``lesana help``.
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..292a0ce
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,28 @@
+.. lesana documentation master file, created by
+   sphinx-quickstart on Thu Oct  1 22:28:26 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to lesana's documentation!
+==================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   getting_started_command_line
+   moving_data_between_collections
+   promises
+
+   man/index
+
+   reference/modules
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/man/Makefile b/docs/source/man/Makefile
index 0369f59..0369f59 100644
--- a/docs/man/Makefile
+++ b/docs/source/man/Makefile
diff --git a/docs/source/man/index.rst b/docs/source/man/index.rst
new file mode 100644
index 0000000..65d92a1
--- /dev/null
+++ b/docs/source/man/index.rst
@@ -0,0 +1,17 @@
+*********
+Man Pages
+*********
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   lesana-edit
+   lesana-export
+   lesana-index
+   lesana-init
+   lesana-new
+   lesana-rm
+   lesana
+   lesana-search
+   lesana-show
diff --git a/docs/man/lesana-edit.rst b/docs/source/man/lesana-edit.rst
index 75bcaeb..75bcaeb 100644
--- a/docs/man/lesana-edit.rst
+++ b/docs/source/man/lesana-edit.rst
diff --git a/docs/man/lesana-export.rst b/docs/source/man/lesana-export.rst
index 6088dbf..6088dbf 100644
--- a/docs/man/lesana-export.rst
+++ b/docs/source/man/lesana-export.rst
diff --git a/docs/man/lesana-index.rst b/docs/source/man/lesana-index.rst
index d535c02..d535c02 100644
--- a/docs/man/lesana-index.rst
+++ b/docs/source/man/lesana-index.rst
diff --git a/docs/man/lesana-init.rst b/docs/source/man/lesana-init.rst
index 92527c0..92527c0 100644
--- a/docs/man/lesana-init.rst
+++ b/docs/source/man/lesana-init.rst
diff --git a/docs/man/lesana-new.rst b/docs/source/man/lesana-new.rst
index 4c7a10d..4c7a10d 100644
--- a/docs/man/lesana-new.rst
+++ b/docs/source/man/lesana-new.rst
diff --git a/docs/man/lesana-rm.rst b/docs/source/man/lesana-rm.rst
index 4f765a5..4f765a5 100644
--- a/docs/man/lesana-rm.rst
+++ b/docs/source/man/lesana-rm.rst
diff --git a/docs/man/lesana-search.rst b/docs/source/man/lesana-search.rst
index 9375541..9375541 100644
--- a/docs/man/lesana-search.rst
+++ b/docs/source/man/lesana-search.rst
diff --git a/docs/man/lesana-show.rst b/docs/source/man/lesana-show.rst
index 516f9de..516f9de 100644
--- a/docs/man/lesana-show.rst
+++ b/docs/source/man/lesana-show.rst
diff --git a/docs/man/lesana.rst b/docs/source/man/lesana.rst
index 0d60e4f..0d60e4f 100644
--- a/docs/man/lesana.rst
+++ b/docs/source/man/lesana.rst
diff --git a/docs/moving_data_between_collections.rst b/docs/source/moving_data_between_collections.rst
index 170b391..23c693e 100644
--- a/docs/moving_data_between_collections.rst
+++ b/docs/source/moving_data_between_collections.rst
@@ -1,5 +1,6 @@
+*******************************
 Moving Data between Collections
-===============================
+*******************************
 
 Entries can be exported from a lesana collection to another using the
 ``lesana export`` command and a jinja2 template.
diff --git a/docs/promises.rst b/docs/source/promises.rst
index 92ab5aa..6a3b04e 100644
--- a/docs/promises.rst
+++ b/docs/source/promises.rst
@@ -1,15 +1,16 @@
+********
 Promises
-========
+********
 
 Semantic versioning
--------------------
+===================
 
 This project uses semver_.
 
 .. _semver: http://semver.org/
 
 Collection format stability
----------------------------
+===========================
 
 Future versions of lesana will be able to read collections written by
 older versions.
@@ -23,7 +24,7 @@ possibile, and will have enought test data to keep them maintained for
 the time being.
 
 Disposable cache
-----------------
+================
 
 Contrary to the yaml files, the xapian cache is considered disposable:
 from time to time there may be a need to delete the cache and reindex
diff --git a/docs/source/reference/lesana.collection.rst b/docs/source/reference/lesana.collection.rst
new file mode 100644
index 0000000..e00613c
--- /dev/null
+++ b/docs/source/reference/lesana.collection.rst
@@ -0,0 +1,7 @@
+lesana.collection module
+========================
+
+.. automodule:: lesana.collection
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/reference/lesana.command.rst b/docs/source/reference/lesana.command.rst
new file mode 100644
index 0000000..729ec1d
--- /dev/null
+++ b/docs/source/reference/lesana.command.rst
@@ -0,0 +1,7 @@
+lesana.command module
+=====================
+
+.. automodule:: lesana.command
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/reference/lesana.data.rst b/docs/source/reference/lesana.data.rst
new file mode 100644
index 0000000..fdbd552
--- /dev/null
+++ b/docs/source/reference/lesana.data.rst
@@ -0,0 +1,7 @@
+lesana.data package
+===================
+
+.. automodule:: lesana.data
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/reference/lesana.rst b/docs/source/reference/lesana.rst
new file mode 100644
index 0000000..bab9655
--- /dev/null
+++ b/docs/source/reference/lesana.rst
@@ -0,0 +1,24 @@
+lesana package
+==============
+
+.. automodule:: lesana
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   lesana.data
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   lesana.collection
+   lesana.command
diff --git a/docs/source/reference/modules.rst b/docs/source/reference/modules.rst
new file mode 100644
index 0000000..1ce51bd
--- /dev/null
+++ b/docs/source/reference/modules.rst
@@ -0,0 +1,7 @@
+lesana reference
+================
+
+.. toctree::
+   :maxdepth: 4
+
+   lesana