Add sphinx config

docs/.gitignore

@@ -0,0 +1,3 @@
+_build/
+_static/
+_templates/

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     = .
+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,67 @@
+# 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('.'))
+sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('../genalog'))
+sys.path.insert(0, os.path.abspath('../genalog/degradation'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'genalog'
+copyright = '2021, Microsoft'
+author = 'Microsoft'
+
+
+# -- 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.napoleon',
+    'sphinx.ext.coverage',
+]
+
+# The master toctree document.
+master_doc = 'index'
+autodoc_member_order = 'groupwise'
+autoclass_content = 'both'
+
+# Napoleon settings
+napoleon_google_docstring = True
+# napoleon_numpy_docstring = True
+
+# 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 = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- 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'
+
+# 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']

docs/genalog/genalog.degradation.rst

@@ -0,0 +1,29 @@
+genalog.degradation package
+===========================
+
+Submodules
+----------
+
+genalog.degradation.degrader module
+-----------------------------------
+
+.. automodule:: genalog.degradation.degrader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+genalog.degradation.effect module
+---------------------------------
+
+.. automodule:: genalog.degradation.effect
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: genalog.degradation
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/genalog/genalog.generation.rst

@@ -0,0 +1,29 @@
+genalog.generation package
+==========================
+
+Submodules
+----------
+
+genalog.generation.content module
+---------------------------------
+
+.. automodule:: genalog.generation.content
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+genalog.generation.document module
+----------------------------------
+
+.. automodule:: genalog.generation.document
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: genalog.generation
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/genalog/genalog.ocr.rst

@@ -0,0 +1,53 @@
+genalog.ocr package
+===================
+
+Submodules
+----------
+
+genalog.ocr.blob\_client module
+-------------------------------
+
+.. automodule:: genalog.ocr.blob_client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+genalog.ocr.common module
+-------------------------
+
+.. automodule:: genalog.ocr.common
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+genalog.ocr.grok module
+-----------------------
+
+.. automodule:: genalog.ocr.grok
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+genalog.ocr.metrics module
+--------------------------
+
+.. automodule:: genalog.ocr.metrics
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+genalog.ocr.rest\_client module
+-------------------------------
+
+.. automodule:: genalog.ocr.rest_client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: genalog.ocr
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/genalog/genalog.rst

@@ -0,0 +1,32 @@
+genalog package
+===============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   genalog.degradation
+   genalog.generation
+   genalog.ocr
+   genalog.text
+
+Submodules
+----------
+
+genalog.pipeline module
+-----------------------
+
+.. automodule:: genalog.pipeline
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: genalog
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/genalog/genalog.text.rst

@@ -0,0 +1,69 @@
+genalog.text package
+====================
+
+Submodules
+----------
+
+genalog.text.alignment module
+-----------------------------
+
+.. automodule:: genalog.text.alignment
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+genalog.text.anchor module
+--------------------------
+
+.. automodule:: genalog.text.anchor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+genalog.text.conll\_format module
+---------------------------------
+
+.. automodule:: genalog.text.conll_format
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+genalog.text.lcs module
+-----------------------
+
+.. automodule:: genalog.text.lcs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+genalog.text.ner\_label module
+------------------------------
+
+.. automodule:: genalog.text.ner_label
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+genalog.text.preprocess module
+------------------------------
+
+.. automodule:: genalog.text.preprocess
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+genalog.text.splitter module
+----------------------------
+
+.. automodule:: genalog.text.splitter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: genalog.text
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/genalog/modules.rst

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

docs/index.rst

@@ -0,0 +1,22 @@
+.. genalog documentation master file, created by
+   sphinx-quickstart on Thu Jan 28 15:19:33 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to genalog's documentation!
+===================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   genalog/genalog
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

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=.
+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

docs/requirements-doc.txt

@@ -0,0 +1,2 @@
+sphinx
+sphinx_rtd_theme