Added basic automatic documentation generation

docs/source/bmlsa.rst

@@ -0,0 +1,53 @@
+bmlsa package
+=============
+
+Submodules
+----------
+
+bmlsa.aligner module
+--------------------
+
+.. automodule:: bmlsa.aligner
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bmlsa.cli module
+----------------
+
+.. automodule:: bmlsa.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bmlsa.datatypes module
+----------------------
+
+.. automodule:: bmlsa.datatypes
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bmlsa.exceptions module
+-----------------------
+
+.. automodule:: bmlsa.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bmlsa.io module
+---------------
+
+.. automodule:: bmlsa.io
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: bmlsa
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/conf.py

@@ -0,0 +1,33 @@
+import os
+import sys
+
+# Configure system path
+
+sys.path.insert(0, os.path.abspath("../src/"))
+
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "BMLSA"
+copyright = "2023, Harrison"
+author = "Harrison"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ["sphinx.ext.autodoc"]
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "alabaster"
+html_static_path = ["_static"]

docs/source/index.rst

@@ -0,0 +1,21 @@
+.. BMLSA documentation master file, created by
+   sphinx-quickstart on Fri Apr 28 13:04:16 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to BMLSA's documentation!
+=================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+   
+   modules
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/modules.rst

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