Code Documentation
##################

.. toctree::
   :maxdepth: 2

OCR
===
.. automodule:: corppa.ocr.gvision_ocr
  :members:


Collate Texts 
-------------
.. automodule:: corppa.ocr.collate_txt
.. Note: not including the members for the method docs, *but* we should we
.. make the top-level comment better.


Utils
=====

Filter Utility
--------------
.. automodule:: corppa.utils.filter
.. Note: not including members for method docs, only top-level script usage

Path Utilities
--------------
.. automodule:: corppa.utils.path_utils
  :members:

Generate PPA Page Set
----------------------
.. automodule:: corppa.utils.generate_page_set
.. Note: not including members for method docs, only top-level script usage

Add Image (Relative) Paths
---------------------------
.. automodule:: corppa.utils.add_image_relpaths
.. Note: not including members for method docs, only top-level script usage

Build Text Corpus
-----------------
.. automodule:: corppa.utils.build_text_corpus
.. Note: not including members for method docs, only top-level script usage


Annotation
==========

Data Preparation
-----------------
Preliminary Page Set Creation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: corppa.poetry_detection.annotation.create_pageset
.. Note: not including members for method docs, only top-level script usage

Add Metadata
^^^^^^^^^^^^
.. automodule:: corppa.poetry_detection.annotation.add_metadata
.. Note: not including members for method docs, only top-level script usage

Annotation Recipes
------------------
.. automodule:: corppa.poetry_detection.annotation.annotation_recipes
.. Note: not including members for method docs, only top-level script usage

Command Recipes
---------------
.. automodule:: corppa.poetry_detection.annotation.command_recipes
.. Note: not including members for method docs, only top-level script usage

Process Adjudication Data
-------------------------
.. automodule:: corppa.poetry_detection.annotation.process_adjudication_data
.. Note: not including members for method docs, only top-level script usage


Poetry Detection
================

Scripts
-------

refmatcha
^^^^^^^^^

.. automodule:: corppa.poetry_detection.refmatcha

Merge excerpts 
^^^^^^^^^^^^^^

.. automodule:: corppa.poetry_detection.merge_excerpts
.. Note: not including members for method docs, only top-level script usage