Added skeleton docs (#6)

- Removed support for Python 3.8, since it's unsupported by the latest
`sphinx`.
- Added `doc` dir with minimal docs.
- Added docs build check in `build` workflow.

.github/workflows/build.yml

@@ -11,11 +11,11 @@ jobs:
     strategy:
       matrix:
         python-version:
-          - "3.8"
           - "3.9"
           - "3.10"
           - "3.11"
           - "3.12"
+      fail-fast: false
     env:
       PYTHONDEVMODE: 1
     steps:
@@ -36,3 +36,5 @@ jobs:
     - run: poetry run mypy
     # Run tests.
     - run: poetry run pytest
+    # Build docs.
+    - run: poetry run sphinx-build -W docs docs/_build

.gitignore

@@ -4,3 +4,4 @@
 /.mypy_cache
 /.venv
 /dist
+/docs/_build

docs/conf.py

@@ -0,0 +1,36 @@
+from __future__ import annotations
+
+from datetime import date
+from pathlib import Path
+
+import tomli
+
+_root = Path(__file__).parent.parent
+_poetry = tomli.loads((_root / "pyproject.toml").read_text())["tool"]["poetry"]
+
+project = _poetry["name"]
+release = version = _poetry["version"]
+author = ", ".join(author[0] for author in _poetry["authors"])
+copyright = f"{date.today().year} Dave Hall"
+
+exclude_patterns = ["_build"]
+
+html_theme = "furo"
+html_title = _poetry["name"]
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+]
+
+autoclass_content = "both"
+autodoc_default_options = {
+    "members": True,
+    "undoc-members": True,
+}
+autodoc_member_order = "groupwise"
+autodoc_typehints = "both"
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+}

docs/index.rst

@@ -0,0 +1,13 @@
+Log-based testing
+=================
+
+.. automodule:: logot
+
+.. toctree::
+   :caption: Contents
+   :hidden:
+   :maxdepth: 1
+
+   self
+   match
+   util

docs/match.rst

@@ -0,0 +1,4 @@
+Matching logs
+=============
+
+.. automodule:: logot.match

docs/util.rst

@@ -0,0 +1,4 @@
+Utilities
+=========
+
+.. automodule:: logot.util

pyproject.toml

@@ -12,17 +12,21 @@ keywords = ["test", "unittest", "pytest", "logging"]
 packages = [{ include = "logot" }]
 
 [tool.poetry.dependencies]
-python = "^3.8"
+python = "^3.9"
 pytest = { version = "^7.4.4", optional = true }
 
 [tool.poetry.extras]
 pytest = ["pytest"]
 
 [tool.poetry.group.dev.dependencies]
+furo = "*"
 mypy = "^1.8.0"
 ruff = "^0.1.11"
 pytest = "*"
 pytest-cov = "^4.1.0"
+sphinx = "*"
+sphinx-autobuild = "*"
+tomli = "^2.0.1"
 
 [tool.coverage.run]
 source = ["logot", "tests"]
@@ -41,7 +45,7 @@ exclude_lines = [
 ]
 
 [tool.mypy]
-files = ["logot/**/*.py", "tests/**/*.py"]
+files = ["docs/**/*.py", "logot/**/*.py", "tests/**/*.py"]
 allow_redefinition = true
 explicit_package_bases = true
 show_column_numbers = true
@@ -53,7 +57,7 @@ console_output_style = "classic"
 addopts = "--tb=native --cov"
 
 [tool.ruff]
-include = ["logot/**/*.py", "tests/**/*.py"]
+include = ["docs/**/*.py", "logot/**/*.py", "tests/**/*.py"]
 line-length = 120
 select = ["E", "F", "W", "I", "UP"]