Trying out read the docs

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "racial_covenants_processor"]
+	path = racial_covenants_processor
+	url = https://github.com/UMNLibraries/racial_covenants_processor.git
+[submodule "mp-covenants-term-search-basic"]
+	path = mp-covenants-term-search-basic
+	url = https://github.com/UMNLibraries/mp-covenants-term-search-basic.git

.readthedocs.yaml

@@ -0,0 +1,32 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#    install:
+#    - requirements: docs/requirements.txt

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     = .
+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)

Pipfile

@@ -0,0 +1,12 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+sphinx = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.12"

_build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 0eca176247edc7eebbb500e8b6e9d373
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_build/html/_sources/index.rst.txt

@@ -0,0 +1,23 @@
+.. The Deed Machine documentation master file, created by
+   sphinx-quickstart on Fri Jun 14 12:54:13 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to The Deed Machine's documentation!
+============================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   racial_covenants_processor/docs/index
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+..
+   Need to follow these steps: https://fmarco76.github.io/git%20and%20related%20services/readthedocs

_build/html/_sources/racial_covenants_processor/docs/index.rst.txt

@@ -0,0 +1,21 @@
+.. The Deed Machine documentation master file, created by
+   sphinx-quickstart on Fri Jun 14 13:08:44 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to The Deed Machine's documentation!
+============================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules/downloading-new-results.rst
+   modules/apps-deed-models.rst
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

_build/html/_sources/racial_covenants_processor/docs/modules/apps-deed-models.rst.txt

@@ -0,0 +1,4 @@
+apps.deed.models.py
+===================
+.. automodule:: apps.deed.models
+   :members:

_build/html/_sources/racial_covenants_processor/docs/modules/downloading-new-results.rst.txt

@@ -0,0 +1,66 @@
+Downloading new batches of Zooniverse results
+=============================================
+
+1. Export updated manual corrections in case something goes wrong, though you generally won't need to reload these (just re-join) unless your database needs to be completely rebuilt
+
+.. code-block:: bash
+
+    python manage.py dump_manual_corrections --workflow "WI Milwaukee County"
+    python manage.py dump_extra_parcels --workflow "WI Milwaukee County"
+
+2. Create and download a fresh Zooniverse export from the Zooniverse Lab tab.  
+    A. Click Lab > Data Exports > Request new workflow classification export  
+    B. Click Lab > Data Exports > Request new workflow export  
+    C. Download files once notified by email.  
+    D. Place downloaded files in a folder named the workflow slugs. (I retain old versions of this folder by renaming with a date stamp, e.g. your-workflow-slug-20240401):
+
+    ::
+
+        racial_covenants_processor
+        ├── racial_covenants_processor
+            ├── data
+                ├── zooniverse_exports
+                    |── your-workflow-slug/
+
+    E. If necessary, rename downloaded files to ``your-workflow-slug-classifications.csv`` (e.g. ``wi-milwaukee-county-classifications.csv``) and ``your-workflow-slug-workflows.csv`` (e.g. ``wi-milwaukee-county-workflows.csv``)
+
+3. Process exported batch results from Zooniverse (Using command line tools)
+
+.. code-block:: bash
+  
+    python manage.py generate_zooniverse_export --workflow "WI Milwaukee County"
+
+4. Load raw and aggregated Zooniverse responses into individual property matches
+
+.. code-block:: bash
+    
+    python manage.py load_zooniverse_export --slow --workflow "WI Milwaukee County"
+
+5. Join deed images to zooniverse subjects
+
+.. code-block:: bash
+    
+    python manage.py join_deeds_to_subjects --workflow "WI Milwaukee County"
+
+6. Re-join manual corrections to subjects
+
+.. code-block:: bash
+    
+    python manage.py connect_manual_corrections --workflow "WI Milwaukee County"
+    python manage.py connect_extra_parcels --workflow "WI Milwaukee County"
+
+7. Automated join of matches to modern parcel map
+
+.. code-block:: bash
+    
+    python manage.py rebuild_covenant_spatial_lookups --workflow "WI Milwaukee County"
+    python manage.py match_parcels --workflow "WI Milwaukee County"
+
+8. Manual cleanup as needed.
+9. Export shapefile/data layers
+
+.. code-block:: bash
+
+    python manage.py dump_covenants_shapefile --workflow "WI Milwaukee County"
+    python manage.py dump_covenants_geojson --workflow "WI Milwaukee County"
+    python manage.py dump_covenants_csv --workflow "WI Milwaukee County"