Implement sphinx and readthedocs.org for documentation

.gitattributes

@@ -2,3 +2,4 @@
 
 *.sh text eol=lf
 *.bash text eol=lf
+*.bat text eol=crlf

.github/workflows/test.yml

@@ -107,3 +107,31 @@ jobs:
     - name: Test with pytest
       run: |
         pytest -p no:smtpd
+
+  docs:
+
+    name: Check minimum versions
+    needs: [minimum, typing]
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.11"]
+        builder: ["html"]
+    timeout-minutes: 5
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: pip
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip setuptools wheel
+        pip install --upgrade sphinx sphinx-rtd-theme
+        pip install --no-deps .
+    - name: Build documentation with Sphinx
+      run: |
+        sphinx-build -b ${{matrix.builder}} ./docs/source ./docs/source/${{matrix.builder}}

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/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,28 @@
+# 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 = 'SMTPDFix'
+copyright = '2023, James Warne'
+author = 'James Warne'
+release = '0.5.2'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx_rtd_theme"
+]
+
+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 = 'sphinx_rtd_theme'
+html_static_path = ['_static']

docs/source/index.rst

@@ -0,0 +1,20 @@
+.. smtpdfix documentation master file, created by
+   sphinx-quickstart on Sun Jul 23 12:30:55 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to smtpdfix's documentation!
+====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

setup.cfg

@@ -52,6 +52,8 @@ testing =
     pytest-timeout
 dev =
     smtpdfix[testing]
+    sphinx
+    sphinx-rtd-theme
     tox
 
 [options.package_data]

tox.ini

@@ -4,6 +4,7 @@ envlist = py{37,38,39,310,311,py39,py310},  # Standard install & test cpython an
           py{311}-cov,                      # Coverage must be 100%
           py{311}-lint                      # Code needs to be pretty!
           py{37}-typing                     # Ensure code is typed
+          docs                              # Make sure the documentation builds
 
 
 [testenv]
@@ -31,3 +32,8 @@ commands = isort --check .
 [testenv:py{37,38,39,310,311,py39,py310}-typing]
 deps = mypy
 commands = mypy
+
+[testenv:docs]
+deps = sphinx
+       sphinx-rtd-theme
+commands = sphinx-build -b html {toxinidir}/docs/source {toxinidir}/docs/build/html