Basic docs structure for RTD

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/source/conf.py

@@ -0,0 +1,64 @@
+# Configuration file for the Sphinx documentation builder.
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+from importlib.metadata import metadata
+
+package_metadata = metadata("auto-archiver")
+project = package_metadata["name"]
+authors = package_metadata["authors"]
+release = package_metadata["version"]
+
+
+# -- General configuration ---------------------------------------------------
+extensions = [
+    "autoapi.extension",            # Generate API documentation from docstrings
+    "myst_parser",                  # Markdown support
+    'sphinxcontrib.mermaid',        # Mermaid diagrams
+    "sphinx.ext.viewcode",          # Source code links
+    "sphinx.ext.napoleon",          # Google-style and NumPy-style docstrings
+    # "sphinx.ext.autodoc",           # Include custom docstrings
+    # 'sphinx.ext.autosummary',       # Summarize module/class/function docs
+]
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+# -- AutoAPI Configuration ---------------------------------------------------
+autoapi_type = 'python'
+autoapi_dirs = ["../../src"]
+autodoc_typehints = "signature"     # Include type hints in the signature
+autoapi_ignore = []                 # Ignore specific modules
+autoapi_keep_files = True          # Option to retain intermediate JSON files for debugging
+autoapi_add_toctree_entry = True    # Include API docs in the TOC
+autoapi_template_dir = None         # Use default templates
+autoapi_options = [
+    "members",
+    "undoc-members",
+    "show-inheritance",
+    "show-module-summary",
+    "imported-members",
+]
+
+
+# -- Markdown Support --------------------------------------------------------
+myst_enable_extensions = [
+    "colon_fence",          # ::: fences
+    "deflist",              # Definition lists
+    "html_admonition",      # HTML-style admonitions
+    "html_image",           # Inline HTML images
+    "replacements",         # Substitutions like (C)
+    "smartquotes",          # Smart quotes
+    "linkify",              # Auto-detect links
+    "substitution",         # Text substitutions
+]
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".md": "markdown",
+}
+
+# -- Options for HTML output -------------------------------------------------
+html_theme = 'furo'
+# html_static_path = ['_static']
+

docs/source/configurations.rst

@@ -0,0 +1,35 @@
+
+Configurations
+==============
+
+This section of the documentation provides guidelines for configuring the tool.
+
+File Reference
+--------------
+
+
+Below is the content of the `example.orchestration.yaml` file:
+
+.. raw:: html
+
+    <details>
+    <summary>View example.orchestration.yaml</summary>
+
+.. literalinclude:: ../../example.orchestration.yaml
+   :language: yaml
+   :caption: example.orchestration.yaml
+
+.. raw:: html
+
+    </details>
+
+
+Configs
+-------
+
+This section of the documentation will show the custom configurations for the individual steps of the tool.
+
+
+.. include:: configs.rst
+
+

docs/source/developer_guidelines.rst

@@ -0,0 +1,6 @@
+
+Developer Guidelines
+====================
+
+This section of the documentation provides guidelines for developers who want to modify or contribute to the tool.
+

docs/source/index.rst

@@ -0,0 +1,27 @@
+.. auto-archiver documentation master file, created by
+   sphinx-quickstart on Sun Jan 12 20:35:50 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Auto Archiver documentation
+===========================
+
+.. note::
+
+   This is a work in progress.
+
+
+.. include:: ../../README.md
+   :parser: myst
+
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+   :caption: Contents:
+
+   developer_guidelines
+   configurations
+   user_guidelines
+   configs
+

docs/source/user_guidelines.rst

@@ -0,0 +1,11 @@
+
+User Guidelines
+===============
+
+This section of the documentation provides guidelines for users who want to use the tool,
+without needing to modify the code.
+To see the developer guidelines, see :ref:`developer_guidelines`.
+
+.. note::
+
+    This is a work in progress.