From 7cbaf473ca385cd64978a2d6f25f2df6af76bdb9 Mon Sep 17 00:00:00 2001
From: Charles Cabergs <me@cacharle.xyz>
Date: Tue, 2 Mar 2021 14:33:51 +0100
Subject: Refactoring test.result.Result

---
 docs/conf.py        |  3 +++
 docs/developers.rst | 12 ++++++++++++
 2 files changed, 15 insertions(+)

(limited to 'docs')

diff --git a/docs/conf.py b/docs/conf.py
index d60ba56..41202d8 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -34,6 +34,7 @@ release = '1.0.1'
 # ones.
 extensions = [
     "sphinx.ext.extlinks",
+    "sphinx.ext.autodoc",
     "sphinxcontrib.programoutput",
 ]
 
@@ -65,6 +66,8 @@ html_context = {
     "github_version": "master",
 }
 
+autodoc_typehints = "description"
+
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
diff --git a/docs/developers.rst b/docs/developers.rst
index 024f100..1ce1150 100644
--- a/docs/developers.rst
+++ b/docs/developers.rst
@@ -3,6 +3,18 @@
 Developers
 ==========
 
+.. autoclass:: minishell_test.test.captured.CapturedCommand
+   :members:
+   :special-members: __init__, __eq__
+
+.. autoclass:: minishell_test.test.captured.CapturedTimeout
+   :members:
+   :special-members: __eq__
+
+.. autoclass:: minishell_test.test.result.BaseResult
+   :members:
+   :special-members: __init__
+
 Install requirements
 --------------------
 
-- 
cgit