Generated documentation!

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)

docs/gen_docs.sh

@@ -0,0 +1,3 @@
+make clean
+sphinx-apidoc -o ./source ../night_horizons -e -f
+make html

docs/index.html

@@ -0,0 +1 @@
+<meta http-equiv="refresh" content="0; url=./build/html/index.html" />

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
+
+%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.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,56 @@
+# 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('../night_horizons'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'night-horizons-mapmaker'
+copyright = '2024, Zachary Hafen-Saavedra'
+author = 'Zachary Hafen-Saavedra'
+
+# The full version, including alpha/beta/rc tags
+release = '0.1'
+
+
+# -- 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',
+]
+
+# 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']

docs/source/index.rst

@@ -0,0 +1,20 @@
+.. night-horizons-mapmaker documentation master file, created by
+   sphinx-quickstart on Wed Apr 10 23:48:58 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to night-horizons-mapmaker's documentation!
+===================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/modules.rst

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

docs/source/night_horizons.container.rst

@@ -0,0 +1,7 @@
+night\_horizons.container module
+================================
+
+.. automodule:: night_horizons.container
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.data_io.rst

@@ -0,0 +1,7 @@
+night\_horizons.data\_io module
+===============================
+
+.. automodule:: night_horizons.data_io
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.exceptions.rst

@@ -0,0 +1,7 @@
+night\_horizons.exceptions module
+=================================
+
+.. automodule:: night_horizons.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.image_processing.batch.rst

@@ -0,0 +1,7 @@
+night\_horizons.image\_processing.batch module
+==============================================
+
+.. automodule:: night_horizons.image_processing.batch
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.image_processing.mosaicking.rst

@@ -0,0 +1,7 @@
+night\_horizons.image\_processing.mosaicking module
+===================================================
+
+.. automodule:: night_horizons.image_processing.mosaicking
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.image_processing.operators.rst

@@ -0,0 +1,7 @@
+night\_horizons.image\_processing.operators module
+==================================================
+
+.. automodule:: night_horizons.image_processing.operators
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.image_processing.processors.rst

@@ -0,0 +1,7 @@
+night\_horizons.image\_processing.processors module
+===================================================
+
+.. automodule:: night_horizons.image_processing.processors
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.image_processing.registration.rst

@@ -0,0 +1,7 @@
+night\_horizons.image\_processing.registration module
+=====================================================
+
+.. automodule:: night_horizons.image_processing.registration
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.image_processing.rst

@@ -0,0 +1,23 @@
+night\_horizons.image\_processing package
+=========================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   night_horizons.image_processing.batch
+   night_horizons.image_processing.mosaicking
+   night_horizons.image_processing.operators
+   night_horizons.image_processing.processors
+   night_horizons.image_processing.registration
+   night_horizons.image_processing.scorers
+
+Module contents
+---------------
+
+.. automodule:: night_horizons.image_processing
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.image_processing.scorers.rst

@@ -0,0 +1,7 @@
+night\_horizons.image\_processing.scorers module
+================================================
+
+.. automodule:: night_horizons.image_processing.scorers
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.io_manager.rst

@@ -0,0 +1,7 @@
+night\_horizons.io\_manager module
+==================================
+
+.. automodule:: night_horizons.io_manager
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.metrics.rst

@@ -0,0 +1,7 @@
+night\_horizons.metrics module
+==============================
+
+.. automodule:: night_horizons.metrics
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.pipeline.rst

@@ -0,0 +1,7 @@
+night\_horizons.pipeline module
+===============================
+
+.. automodule:: night_horizons.pipeline
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.raster.rst

@@ -0,0 +1,7 @@
+night\_horizons.raster module
+=============================
+
+.. automodule:: night_horizons.raster
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.rst

@@ -0,0 +1,34 @@
+night\_horizons package
+=======================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   night_horizons.image_processing
+   night_horizons.transformers
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   night_horizons.container
+   night_horizons.data_io
+   night_horizons.exceptions
+   night_horizons.io_manager
+   night_horizons.metrics
+   night_horizons.pipeline
+   night_horizons.raster
+   night_horizons.utils
+
+Module contents
+---------------
+
+.. automodule:: night_horizons
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.transformers.filters.rst

@@ -0,0 +1,7 @@
+night\_horizons.transformers.filters module
+===========================================
+
+.. automodule:: night_horizons.transformers.filters
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.transformers.order.rst

@@ -0,0 +1,7 @@
+night\_horizons.transformers.order module
+=========================================
+
+.. automodule:: night_horizons.transformers.order
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.transformers.preprocessors.rst

@@ -0,0 +1,7 @@
+night\_horizons.transformers.preprocessors module
+=================================================
+
+.. automodule:: night_horizons.transformers.preprocessors
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.transformers.raster.rst

@@ -0,0 +1,7 @@
+night\_horizons.transformers.raster module
+==========================================
+
+.. automodule:: night_horizons.transformers.raster
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.transformers.rst

@@ -0,0 +1,21 @@
+night\_horizons.transformers package
+====================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   night_horizons.transformers.filters
+   night_horizons.transformers.order
+   night_horizons.transformers.preprocessors
+   night_horizons.transformers.raster
+
+Module contents
+---------------
+
+.. automodule:: night_horizons.transformers
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/night_horizons.utils.rst

@@ -0,0 +1,7 @@
+night\_horizons.utils module
+============================
+
+.. automodule:: night_horizons.utils
+   :members:
+   :undoc-members:
+   :show-inheritance: