Add build environment for the documentation

.github/requirements-core.txt

@@ -0,0 +1,4 @@
+PyYAML >=5.1
+packaging
+setuptools
+git-props

.github/workflows/rst-lint.yaml

@@ -0,0 +1,30 @@
+name: Check ReST input files
+on:
+  push:
+    branches:
+      - develop
+      - master
+  pull_request:
+jobs:
+  doc8:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+      - name: Install dependencies
+        run: |
+          pip install -r .github/requirements-core.txt
+      - name: Run conf.py
+        run: |
+          python setup.py build
+          python doc/src/conf.py
+      - name: doc8-check
+        uses: deep-entertainment/doc8-action@v5
+        with:
+          scanPaths: "doc/src"

.readthedocs.yaml

@@ -0,0 +1,21 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+  jobs:
+    post_checkout:
+      - git fetch --unshallow
+    post_install:
+      - python setup.py build
+
+sphinx:
+  configuration: doc/src/conf.py
+
+python:
+  install:
+    - requirements: .rtd-require

.rtd-require

@@ -0,0 +1,7 @@
+PyYAML >=5.1
+lark
+packaging
+setuptools
+git-props
+python-dateutil
+sphinx_rtd_theme

Makefile

@@ -10,6 +10,12 @@ test:
 sdist:
 	$(PYTHON) setup.py sdist
 
+doc-html: build
+	$(MAKE) -C doc html
+
+doc-man: build
+	$(MAKE) -C doc man
+
 clean:
 	rm -rf build
 	rm -rf __pycache__
@@ -18,9 +24,10 @@ distclean: clean
 	rm -f MANIFEST _meta.py
 	rm -rf dist
 	rm -rf tests/.pytest_cache
+	$(MAKE) -C doc distclean
 
 meta:
 	$(PYTHON) setup.py meta
 
 
-.PHONY: build test sdist clean distclean meta
+.PHONY: build test sdist doc-html doc-man clean distclean meta

doc/.gitignore

@@ -0,0 +1,20 @@
+/src/_meta.rst
+/devhelp/
+/dirhtml/
+/doctest/
+/doctrees/
+/epub/
+/gettext/
+/html/
+/htmlhelp/
+/json/
+/latex/
+/linkcheck/
+/man/
+/pickle/
+/pseudoxml/
+/qthelp/
+/singlehtml/
+/texinfo/
+/text/
+/xml/

doc/Makefile

@@ -0,0 +1,28 @@
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = archive-tools
+SOURCEDIR     = src
+BUILDDIR      = .
+BUILDERS      = html dirhtml singlehtml htmlhelp qthelp devhelp epub	\
+		latex latexpdf man texinfo text gettext linkcheck xml	\
+		json pickle
+
+# Subdirectories of the source directory that are supposed to be there
+# but that may be empty and may thus be missing after a git checkout.
+STATIC_SOURCEDIRS = $(SOURCEDIR)/_static $(SOURCEDIR)/_templates
+
+
+help:
+	$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+$(BUILDERS): $(STATIC_SOURCEDIRS)
+	$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+distclean:
+	rm -rf doctrees $(BUILDERS)
+	rm -f src/_meta.rst
+
+$(STATIC_SOURCEDIRS):
+	mkdir $@
+
+.PHONY: help distclean $(BUILDERS)

doc/src/08A1264175343E6E.pub

@@ -0,0 +1,98 @@
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+
+mQINBFgqIDYBEADs08vJtPmKgfaSkKTtHWaYOmCchuXtaTd766b3tDaL55XfTucS
+OGVUk1hbaMl8aAZoEmwCDIIMFUGL21QNdZTPLOWv29qXNnUjQEB7vUoJvafZPzTh
++38PDkOeLCQ67J/OSHkRQvEFGc6EXNo/GbtZ1oAGQXFeMbcFg7EuEQvEbHxyJAMo
+6a+q9fHB/YkTJVkMFkPnBw2Lbywa5LVJ6ZZWk+IyxbeIZhcjTkpaZMSQhNJAF14q
+4uKOGhVupfKZmvwnEvrNwp5ImTiiu6mRuywVDwxXUVersCuIhL/ZQeKI1ImboxW3
+v3p0msxzPaGi0tyb4H7mi/W5rat0u+Zm2EaxYjJDADaNSluxZweUgCi2V/tCzZtP
+FgnElFYPHphay8rZ8bbcw5YfcFrC9tdF0sDD1p7qmpOnVlKPw67RwS148+ew7sxy
+gW56qJP6AgbVVInJU2XNziphpPBbOYkPhYEa0HsAO62ubESPHJHTHuaMe0m+BbNh
+bS2jtPrCaSC5ci6fsVsz0nl5zIFmpDOWKzHNjl5rCcQeV6WXCXeW+f8OfFTe0BXb
+nn2qTq2nY+QMNXMiJ0RKwD/XCCphXLlkN5Oflt3JBAEMFMDbptUf8Zd74+xrdjQj
+byFu3FLB+3h1oMX+7heoul4LQVbE/qH/fkUIPsSky51I4XWLlgnVy1PQKwARAQAB
+tB1Sb2xmIEtyYWhsIDxyb2xmQHJvdGtyYXV0LmRlPokCPAQTAQIAJgIbAwcLCQgH
+AwIBBhUIAgkKCwQWAgMBAh4BAheABQJYKisKAhkBAAoJEAihJkF1ND5uLzQQALnu
+VyxylxLRlSQ16KAA8mfX2BVcC+3IMj9IyYYIj5Vt7BXbFtBS+sAKQ9sqXVpHzob0
+s5Rfat6sFimO0TDeNlhnS1hRZ1USQJUJ+V8c3L6OmpyNemG3/6Qi0iNYazfE71TA
+Km4mW3wgPq8H0/hnKe7tEggPkrhENbo7JDideQ1wAVT9KFu49M2Vm80hUVHiEQh+
+1VbThRmzJjINCiYALcHMo7ZO5uNBenn9zetlKAYpLnRApmPuyAi0jisheJs1gap5
+EtDbcxsD1bqtOKVnJIWqAB7yJDThdDENyo93y2w9BMycobNl3eL7MoB6Ep+Rc8Ae
+XIF/HwFtK0j84B+2dUvUHOQZuX3Qtlgu1FenwlOe8u0nwwur1q/Nz7YWg7anagn9
+yA+uDAsO5eclGAqTT5PHjSaEiPtANmRRKijCeHjB7OVTgtT1nY6ThFurDeFnk55J
+mTmcaQg9ZPSKeCfWwC+BX+p/9V9Pz5LVa9tyFdxHJERxze4CrwcQkQLFSH+CavLa
+iWDLyiAydEa0XU6MU5EmrkwUIHLKzC7ZzwuLkQhC8PXZCifTSkHP7gH4uUUMo2nK
+6JQnRC+ylOlyBWSVlzkhYXlKcAbmrw095z70OKx4GVFyBfi3PLjceHjNvA/QPCQR
+FIEh65MUYDtSz7LpUwvFYUWVFSuV7zzHlHiT3kYIiEYEExECAAYFAlgqLe8ACgkQ
+UcvGPyCdlGbVYwCfYse0zET860S+E71M3Tlfp4brzOIAoOlm+m7wGU6DzTjGyGCa
+zPLpoBq4iQEcBBMBAgAGBQJYKi5TAAoJEIPzNkMsf8yRK+sIAKC9HqZY/f5po06Z
+gy1rWF5qDBA5GxehwYiD3kZ1EhbINjPbujNLIvpzTce2T4mhu1Ibk8fahu/Viwjy
+7n0b0zf9xSiQuUVftopHOf0jfx7oGCVTOMbcENV/UN7SoXCBiKMDDlcfd9Kdt8Ft
+nGyqxod3snJMn6G1VKTBCyLECh7BvyBE4oOQhyPgFYrIKwymOq+mBSPd9j3QjvRu
+xpqteVOr32IYDYNbcxPIu2q6uydnjZxXdlvuo0xl8wwJgka4zGKj0DboajZyMEvR
+OKbs5dQ6pwzRnxvJMxWSB/q4MOWOvtJcVyJP2eYLgE/dcMgN8UgUUjkcJ8G2eSv2
+DgunBHu0H1JvbGYgS3JhaGwgPHJvbGZAdW5pLWJyZW1lbi5kZT6JAjkEEwECACMF
+AlgqIb8CGwMHCwkIBwMCAQYVCAIJCgsEFgIDAQIeAQIXgAAKCRAIoSZBdTQ+biHz
+D/4pB8FRxJdNYegk5B1HlwzKBrmR/9HW6iJa4MinxOyiPNew3mQRzw/FBM9w1F8h
+TL5s+28u/swjwntNLbI5QMYQ+JcSRgmkmzP0lPSS0i+fPm/QjpAsZ/8HTAIUIVPX
+6HHOUbCtcqKVePeSIxuubF0QX2dB4uu2BhEdOcaqBkopL0QMTZx4qAaGfh0tKWc5
+Q6genqXmD24cCSezfGwnQrd/2KvgyWkf7OltZHnyOUmoaAamujkttbtVETeybbY7
+GG73nc/Nv40ypzLQmqK6GK2pUmMoM2k3KdsInxTuBWsKjcGLU/FfvPSMsXwaaCHx
+N+QByU1d3rc/RDkrw6oHnrGqXQDwvKGpJ3bcAaUpshI/ywRPUUiMOlUPvmMHg4wV
+nKSrwJs+9hsf6v930E3Wku3Ohuqf8I7AaMFSSop8McemZQuoMgGSzCuF8rdOlvgj
+wY6mOuQ8jSUtvNi6+8NC+tL1DM4p90fx/kn4vI6TJ+34lZ/hMiRj6JH4bbTLEfdS
+PL3M3vmh7xl6im2WsBnJaCFpmml7sgIGWIoy8A8dAOEkfmb7kZtGYZwqBSIex4Hu
+WdfeEQifzoxBX2YAJjYdMJUUf217+x06s1ML4uChg9csBrphXnMmTzHFXsdI78hh
+Cf/f7I/o+mAO49ww4DaZV1SQXjoFQ6iCamsiJaH1nKhnXYhGBBMRAgAGBQJYKi30
+AAoJEFHLxj8gnZRmG5AAoOM1SRMiNBJeR5OeYwsBGuan0ElmAJ4sb+N0emeAImsJ
+k1JH3Fuht4/ixIkBGwQTAQIABgUCWCouWAAKCRCD8zZDLH/MkZFMB/QMFHwGT1km
+DFDmZKkChCWnL0P5aopsMaCxqx3Ru5aqO87QDRjLOHSK8Emt5sp0Pz1FGJxAUOby
+bCll0yG9qFSOU51QQQYEKUSELpMyT4/PdmzGPA8yYclrnq/BJ1cwPnZjw4soRZrL
+PiFRYvSb16PF29xGTQF0ejFjSnBnCMNGeoIExtlW5hyGwDoZ1cJgvOqd/o5hyy5D
+TxvEFtri0Bx3nCyGrERbH6HNP6Of0+D+MiH/IQKDkfMHaMiR1hHyb4facBALD66e
+1dZLp3eKDQdvVZBP2NGW+BOpVLG6Zs1tbGdVCXq6CJEG+zM3xFaUNtAXck09zub3
+IF+F44NY+yu0H1JvbGYgS3JhaGwgPFJvbGYuS3JhaGxAZ214Lm5ldD6JAjkEEwEC
+ACMFAlgqIZ4CGwMHCwkIBwMCAQYVCAIJCgsEFgIDAQIeAQIXgAAKCRAIoSZBdTQ+
+bjG8EADiP2oUqpgTz80cy193k7Lo+NEvcEkNgh7bc6W7dLwz7vL7cMBQ9K0qAQjq
+TeGHucOM5ju7iDDPOVhchRJFCRl+rg35WaFCmiDd2x4j8c28sSrI+znj9dw5vLfk
+8dShS6Ux6ocgLHwd5jh2ErAb3AKEGyVysA+0wydT/44jiLWjRSEF6qIDTmuxsc3L
++/f2ZBHtwRMI2fHWuosXY7Wkb8XTq/4kGgEL/DJrs0AQv/Ww17hfQhf1SYAQSgEK
+DC90KsQzJzvAgsplQcJovwKFEgQUZ6ox5x/jhqnj1It0WYALJ4s0qUKOLqi+RKcZ
+swpBb0Aq45UMu0KJ+EKWtGG6snfu/d00K+KncS8qBav7ciZ5EP13TdKJNwOcKd8i
+NiSnP86yvNHZ5gST/++M8wB9NjhHbf50+JxQ0lJTg6o8rW2IdTjiHUXf5Z3YmwgS
+WmH7byhn1leTces2NfsCGKN6j6/0YwKUyOG8XpgAiY34TLXMZbI4zsV07aJY9vRY
+Vn45Co0nwOBbl3WMattWg94myQrIyMkEnETStzsO7s/jOIVW8bS4OXdOZg8DY9PE
+71k8XQA9Puc5NucYioFosyNWikGoU058qoTQzVXpSgoI9cdTniZGfHoguBqr7X2L
+NaX75L5dnwPepM1Z5iFl3P5aBB6rnkW5ZEkftXTOmt8doqj2SohGBBMRAgAGBQJY
+Ki30AAoJEFHLxj8gnZRmd1gAoIgAm3VJlohlxaxL4Rk4JaRSvjTcAKDEq8E7j6S6
+4f8JiP2sciLBjUR814kBHAQTAQIABgUCWCouWAAKCRCD8zZDLH/MkU9HB/4p5G0P
+O/u5P+hkiCPIZiiMo1DmvuQkQZEDqDobnHaxB5t2SyfdPyM9VJ5rOVSgXwYfxXSJ
+3A6eHW5sHtjWqa/eD0dosY+lVJPA/dbJ9RNCPU1YgpfOZSiYtJiAIC3kRd2e4mPW
+WwxJqXvTTy+T3aDwt1mfJR8SG1UP2+aiGCVbUWbo1y2EfHUBRc981pKCMERsgemh
+WggvRYNkbfyuSF5Mt32beXx91W7TE7hoivKsngzbO82taD9asCSFzmZn3C5BfYth
+E3iqb2EmSUbQkRzhfXk7RxoxY7RWeDodFXkRzVbwBXFY3Q7XfRNhtVA7d0O+zIWq
+p2DtvLsITicrQxS8uQINBFgqIDYBEADU/dsD2NXhQVQZL12c8Yt6Nj/Ma73B/SaP
+wSmyF7f0pPO3sLO0r5wOebolwbGytIh52G/7i1ZdFNJ+D06tbGNc5CUgkgcNTY+x
+ND4zazWoaooEsx2TPYqDqSmJbEjeDvr//QvCQ8x7ky1p/iAEvCuFSFiAH0HGXuBU
+MiM/MoBC7W3tyS9pbDy43+uphwO0A24Mrxem84zvHBFBFI/pinrp4laU1PMVaSSc
+q82ENCGjXhvF8Ummq1F1XclQ+pza+uGBChz6QMG8EB2WRlFQqoR9xa+K3UmC+UO6
+fAkMx8p/LAuAABGphAAGZc011yuYS9uCh9zNFyBOakqLJRP4+faRWxWkzD8d2Cq+
+9I9CpiM0a3bC56VKPFeic8Xwvd81wDIp39eha8OQpMvSZp54j84hDP83IBl8D/Yl
+vzKO3Xag1Eg0c92N1mNbLhV75oAbmUgOrJktg2bJjRaUOGN+KuwKUvTUawsIBIAW
+xIZP2rLhT21ffSEYC/TZYD39O748lUgcBDH/czTfH+pf1mapjOFaLD+c4lA/hN19
+Su6RqJ8oYTMNsFNWzMmUAsWrCSFnGFhXeOW6kH7AqJ6FMHnsAiCHuhJGKi0Qe76n
+wBDr0ut1XqELHK0hC+LJlHufbfsniuG8QqLzmmWr8aX64pyPU8FtB1hYG8tBjkqj
+fKIbRKnsBwARAQABiQIfBBgBAgAJBQJYKiA2AhsMAAoJEAihJkF1ND5uOoYQAIgg
+DsLqsjW0awdhf/nNK3haDbvYQhtmOmskcKQW7fQXHm0kqGoIliQN57fJNH88OT+9
+Rp6wYjKPblVSNIbcQ8M2nXEVkNtAtO7uC2WVcZeFNVQIsrXX22302riADy7IK51f
+RILnCdyrePehxfyscw0VhJIYDx76iZVM0lNKfuZj00CLXOG76V5/T1o4uu8UAVe5
+cW/astcA+u8pU2u7dyUMcaU9kK0rDz2HI+b1CMs+EGPnEVOqML+RxGTIufYUoqSX
+tWHXsMSWq6IK22A42m4E6HNtcNAKUK7jGLoOdHA0QaFVxHmajG+pUM9MWTcvZrsn
+ZFDlDhyqrF4LBPLG5vk+C4HxdOIEWC+X5GrdESjYWxv14M0ZxustEGkf5VQHdbgE
+W+RcqkwkEbiDjLoaFvOZu+NSy0EXxDtBTlkllBJMn01IAxAVgP8M7T/fZ7lg4uLz
+RBRhm0T9/IvWjAx0wsiNr45iJ++5sJCQWxU4lWFjSrACPzCY0fP2nDMMBfkn58w/
+r0/tDFumEvBXHCVzdhLzUbetrzmNwGaZdg14ahlEnbbhQktYc+rWbE+ObX74WwHk
+0ziR94MVr/9v144v0GuvBZaycUfe1ljHiPjMnjroODyZ48NjRWY83NolEaQhg+Zf
+BzxtQzjcEYPj7MEcrHXhzM7gQQ8wnzhc39eK6bKv
+=IIFi
+-----END PGP PUBLIC KEY BLOCK-----

doc/src/changelog.rst

@@ -0,0 +1 @@
+.. include:: ../../CHANGES.rst

doc/src/cli.rst

@@ -0,0 +1,25 @@
+Command line scripts
+====================
+
+This section provides a reference for the command line scripts that
+are installed with archive-tools.
+
+.. _archive-tool:
+
+archive-tool
+~~~~~~~~~~~~
+
+The :ref:`archive-tool` script is the major command line interface
+that most users will use to create and manage archives.  It provides
+the following subcommands:
+
+.. toctree::
+   :maxdepth: 1
+
+   man-archive-tool-create
+   man-archive-tool-verify
+   man-archive-tool-ls
+   man-archive-tool-info
+   man-archive-tool-check
+   man-archive-tool-diff
+   man-archive-tool-find