Use mkdocs to build docs

Author: sevein

.readthedocs.yml

@@ -0,0 +1,10 @@
+version: 2
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+mkdocs:
+  configuration: docs/mkdocs.yml
+python:
+  install:
+  - requirements: docs/requirements.txt

docs/.gitignore

@@ -0,0 +1,2 @@
+/.venv
+/site

docs/mkdocs.yml

@@ -0,0 +1,30 @@
+site_name: "Enduro SDPS"
+site_url: "https://enduro.readthedocs.io"
+site_description: "Enduro SDPS documentation site."
+site_author: "Artefactual Systems Inc."
+repo_url: "https://github.com/artefactual-sdps/enduro"
+edit_uri: "blob/main/docs/"
+docs_dir: "src"
+site_dir: "site"
+
+nav:
+- "Home": "index.md"
+- "User manual": "user-manual/"
+- "Developer manual": "dev-manual/"
+- "About":
+  - "Repository": "https://github.com/artefactual-sdps/enduro"
+  - "Issues": "https://github.com/artefactual-sdps/enduro/issues"
+  - "License": "https://github.com/artefactual-sdps/enduro/blob/main/LICENSE"
+
+plugins:
+- autorefs
+- literate-nav:
+    nav_file: README.md
+
+theme:
+  name: readthedocs
+  highlightjs: true
+  hljs_languages:
+  - yaml
+  - json
+  - go

docs/requirements.in

@@ -0,0 +1,3 @@
+mkdocs
+mkdocs-autorefs
+mkdocs-literate-nav

docs/requirements.txt

@@ -0,0 +1,49 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile
+#
+click==8.1.7
+    # via mkdocs
+ghp-import==2.1.0
+    # via mkdocs
+jinja2==3.1.2
+    # via mkdocs
+markdown==3.5.1
+    # via
+    #   mkdocs
+    #   mkdocs-autorefs
+markupsafe==2.1.3
+    # via
+    #   jinja2
+    #   mkdocs
+mergedeep==1.3.4
+    # via mkdocs
+mkdocs==1.5.3
+    # via
+    #   -r requirements.in
+    #   mkdocs-autorefs
+    #   mkdocs-literate-nav
+mkdocs-autorefs==0.5.0
+    # via -r requirements.in
+mkdocs-literate-nav==0.6.1
+    # via -r requirements.in
+packaging==23.2
+    # via mkdocs
+pathspec==0.11.2
+    # via mkdocs
+platformdirs==3.11.0
+    # via mkdocs
+python-dateutil==2.8.2
+    # via ghp-import
+pyyaml==6.0.1
+    # via
+    #   mkdocs
+    #   pyyaml-env-tag
+pyyaml-env-tag==0.1
+    # via mkdocs
+six==1.16.0
+    # via python-dateutil
+watchdog==3.0.0
+    # via mkdocs

docs/src/dev-manual/README.md

@@ -0,0 +1,9 @@
+# Developer manual
+
+This is the developer manual for Enduro SDPS.
+
+- [Dependency management](deps.md)
+- [Enviornment setup](devel.md)
+- [Logging](logging.md)
+- [Makefile](make.md)
+- [Testing](testing.md)

docs/deps.md docs/src/dev-manual/deps.md

@@ -0,0 +1,3 @@
+# Enduro SDPS
+
+Hello world!

docs/devel.md docs/src/dev-manual/devel.md

@@ -0,0 +1,7 @@
+# User manual
+
+This is a user manual for SDPS Enduro, a version of the Enduro project that
+uses a3m to preserve digital objects.
+
+- [Introduction](intro.md)
+- [Usage](usage.md)

docs/logging.md docs/src/dev-manual/logging.md

@@ -0,0 +1,41 @@
+# Introduction
+
+Enduro is a tool that was developed to automate the processing of transfers in
+multiple Archivematica pipelines.
+
+This version of Enduro uses [a3m](https://github.com/artefactual-labs/a3m)
+instead of Archivematica to preserve digital objects, alongside
+[MinIO](https://min.io/) for object storage and [Temporal](https://temporal.io/)
+to manage the workflow. This combination of tools is intended to be lightweight,
+scalable, and easy to install.
+
+## Components
+
+### MinIO
+
+[MinIO](https://min.io/) is a flexible, high performance object storage
+platform. Enduro uses MinIO as its storage back-end for both uploading
+submission information packages (SIPs) and storing archival information packages
+(AIPs). Material intended for preservation can be uploaded to MinIO either
+through the user interface or via command line using the [MinIO
+client](https://min.io/docs/minio/linux/reference/minio-mc.html). Any time new
+content is uploaded to a designated bucket in MinIO, a transfer is started in
+Enduro.
+
+### Temporal
+
+[Temporal](https://temporal.io/) is responsible for orchestrating Enduro's
+workflows - that is, for kicking off tasks, managing them, and recording them as
+auditable events. It also manages retries and timeouts, resulting in a reliable
+platform that can process digital objects for preservation in a highly automated
+environment.
+
+### a3m
+
+[a3m](https://github.com/artefactual-labs/a3m) is a streamlined version of
+[Archivematica](https://archivematica.org) that is wholly focused on AIP
+creation. It does not have external dependencies, integration with access
+systems, search capabilities, or a graphical interface. It was designed to
+reduce the bulk of Archivematica's extraneous functions for users operating at a
+large scale who are more focused on throughput of digital objects for
+preservation.

docs/make.md docs/src/dev-manual/make.md

@@ -1,49 +1,4 @@
-# User manual
-
-This is a user manual for SDPS Enduro, a version of the Enduro project that
-uses a3m to preserve digital objects.
-
-## What is SDPS Enduro?
-
-Enduro is a tool that was developed to automate the processing of transfers in 
-multiple Archivematica pipelines.
-
-This version of Enduro uses [a3m](https://github.com/artefactual-labs/a3m)
-instead of Archivematica to preserve digital objects, alongside
-[MinIO](https://min.io/) for object storage and [Temporal](https://temporal.io/)
-to manage the workflow. This combination of tools is intended to be lightweight,
-scalable, and easy to install.
-
-### Components
-
-#### MinIO
-
-[MinIO](https://min.io/) is a flexible, high performance object storage
-platform. Enduro uses MinIO as its storage back-end for both uploading
-submission information packages (SIPs) and storing archival information packages
-(AIPs). Material intended for preservation can be uploaded to MinIO either
-through the user interface or via command line using the [MinIO
-client](https://min.io/docs/minio/linux/reference/minio-mc.html). Any time new
-content is uploaded to a designated bucket in MinIO, a transfer is started in
-Enduro.
-
-#### Temporal
-
-[Temporal](https://temporal.io/) is responsible for orchestrating Enduro's
-workflows - that is, for kicking off tasks, managing them, and recording them as
-auditable events. It also manages retries and timeouts, resulting in a reliable
-platform that can process digital objects for preservation in a highly automated
-environment.
-
-#### a3m
-
-[a3m](https://github.com/artefactual-labs/a3m) is a streamlined version of
-[Archivematica](https://archivematica.org) that is wholly focused on AIP
-creation. It does not have external dependencies, integration with access
-systems, search capabilities, or a graphical interface. It was designed to
-reduce the bulk of Archivematica's extraneous functions for users operating at a
-large scale who are more focused on throughput of digital objects for
-preservation.
+# Usage
 
 ## Creating an AIP
 
@@ -74,8 +29,8 @@ zipped bag. a3m will automatically recognize the transfer type and adjust its
 processing workflow accordingly.
 
 * **Zipped directory**: digital objects that have been packaged together using
-  the `.zip`, `.tgz`, or `.tar.gz` packaging format. When a zipped directory 
-  transfer starts, the zip will be unpacked. The internal structure of a zipped 
+  the `.zip`, `.tgz`, or `.tar.gz` packaging format. When a zipped directory
+  transfer starts, the zip will be unpacked. The internal structure of a zipped
   directory transfer can either be a loose collection of files, or it can
   include structures like a metadata directory.
 
@@ -107,7 +62,7 @@ in the Archivematica documentation.
 
 3. In the file browser, locate your transfer package and upload it to MinIO.
    Once the progress bar has completed, Enduro will begin processing the
-   transfer. 
+   transfer.
 
 ### View tasks in Enduro
 
@@ -157,7 +112,7 @@ material into an AIP:
 * **Change object and directory filenames**: removes prohibited characters from
   folder and filenames, such as ampersands.
 * **Identify file format**: Identifies the format of all digital objects and
-  metadata files. See 
+  metadata files. See
   [Identification](https://www.archivematica.org/en/docs/archivematica-latest/user-manual/preservation/preservation-planning/#identification)
   in the Archivematica documentation for more information.
 * **Characterize and extract metadata**: extracts technical metadata embedded in