Updating docs

Author: domdfcoding

doc-source/api/bases.rst

@@ -2,8 +2,7 @@
 :mod:`domdf_python_tools.bases`
 *********************************
 
-.. contents:: Table of Contents
-
 .. automodule:: domdf_python_tools.bases
+	:autosummary:
 	:members:
 	:undoc-members:

doc-source/api/dates.rst

@@ -6,12 +6,11 @@
 
 	pytz >=2019.1
 
-.. contents:: Table of Contents
-
 
 .. warning:: This module has not been fully tested. Use with caution.
 
 
 .. automodule:: domdf_python_tools.dates
+	:autosummary:
 	:members:
 	:undoc-members:

doc-source/api/doctools.rst

@@ -2,8 +2,7 @@
 :mod:`domdf_python_tools.doctools`
 **************************************
 
-.. contents:: Table of Contents
-
 .. automodule:: domdf_python_tools.doctools
+	:autosummary:
 	:members:
 	:undoc-members:

doc-source/api/pagesizes.rst

@@ -2,10 +2,9 @@
 :mod:`domdf_python_tools.pagesizes`
 =========================================
 
-.. contents:: Table of Contents
-
 .. automodule:: domdf_python_tools.pagesizes
 	:members:
+	:autosummary:
 	:undoc-members:
 
 
@@ -14,6 +13,7 @@
 
 .. automodule:: domdf_python_tools.pagesizes.classes
 	:members:
+	:autosummary:
 	:undoc-members:
 
 
@@ -22,6 +22,7 @@
 
 .. automodule:: domdf_python_tools.pagesizes.sizes
 	:members:
+	:autosummary:
 	:undoc-members:
 
 
@@ -30,13 +31,14 @@
 
 .. automodule:: domdf_python_tools.pagesizes.units
 	:members:
+	:autosummary:
 	:undoc-members:
 
 
-
 :mod:`domdf_python_tools.pagesizes.utils`
 ----------------------------------------------
 
 .. automodule:: domdf_python_tools.pagesizes.utils
 	:members:
+	:autosummary:
 	:undoc-members:

doc-source/api/paths.rst

@@ -2,8 +2,7 @@
 :mod:`domdf_python_tools.paths`
 **********************************
 
-.. contents:: Table of Contents
-
 .. automodule:: domdf_python_tools.paths
 	:members:
+	:autosummary:
 	:undoc-members:

doc-source/api/terminal.rst

@@ -2,8 +2,7 @@
 :mod:`domdf_python_tools.terminal`
 ***********************************
 
-.. contents:: Table of Contents
-
 .. automodule:: domdf_python_tools.terminal
 	:members:
+	:autosummary:
 	:undoc-members:

doc-source/api/terminal_colours.rst

@@ -2,7 +2,5 @@
 :mod:`domdf_python_tools.terminal_colours`
 *******************************************
 
-.. contents:: Table of Contents
-
 .. automodule:: domdf_python_tools.terminal_colours
 	:members:

doc-source/api/utils.rst

@@ -2,8 +2,7 @@
 :mod:`domdf_python_tools.utils`
 *********************************
 
-.. contents:: Table of Contents
-
 .. automodule:: domdf_python_tools.utils
 	:members:
+	:autosummary:
 	:undoc-members:

doc-source/requirements.txt

@@ -1,12 +1,12 @@
 autodocsumm
 extras_require
-pytz >=2019.1
-sphinx >=3.0.3
-sphinx-copybutton >=0.2.12
+pytz>=2019.1
+sphinx-copybutton>=0.2.12
 sphinx-notfound-page
-sphinx-prompt >=1.2.0
-sphinx-tabs >=1.1.13
-sphinx_autodoc_typehints >=1.11.0
-sphinx_rtd_theme
-sphinxcontrib-httpdomain >=1.7.0
-sphinxemoji >=0.1.6
+sphinx-prompt>=1.2.0
+sphinx-tabs>=1.1.13
+sphinx>=3.0.3
+sphinx_autodoc_typehints>=1.11.0
+sphinx_rtd_theme<0.4
+sphinxcontrib-httpdomain>=1.7.0
+sphinxemoji>=0.1.6

domdf_python_tools/terminal_colours.py

@@ -92,12 +92,23 @@ def clear_line(mode: int = 2) -> str:
 	return CSI + str(mode) + 'K'
 
 
-class Color(str):
+class Colour(str):
+	"""
+	An ANSI escape sequence representing a colour.
+
+	:param style: Escape sequence representing the style.
+	:type style: str
+	:param stack: The stack to place the escape sequence on.
+	:type stack: str
+	:param reset: The escape requence the reset the style.
+	:type reset: str
+	"""
+
 	style: str
 	reset: str
 	stack: List[str]
 
-	def __new__(cls, style: str, stack: List[str], reset: str) -> "Color":
+	def __new__(cls, style: str, stack: List[str], reset: str) -> "Colour":
 		color = super().__new__(cls, style)  # type: ignore
 		color.style = style
 		color.stack = stack
@@ -119,17 +130,25 @@ def __call__(self, text) -> str:
 
 
 class AnsiCodes(ABC):
+	"""
+	Abstract base class for ANSI Codes.
+	"""
+
 	_stack: List[str]
 	_reset: str
 
 	def __init__(self) -> None:
-		# the subclasses declare class attributes which are numbers.
-		# Upon instantiation we define instance attributes, which are the same
-		# as the class attributes but wrapped with the ANSI escape sequence
+		"""
+		The subclasses declare class attributes which are numbers.
+
+		Upon instantiation we define instance attributes, which are the same
+		as the class attributes but wrapped with the ANSI escape sequence.
+		"""
+
 		for name in dir(self):
 			if not name.startswith('_'):
 				value = getattr(self, name)
-				setattr(self, name, Color(code_to_chars(value), self._stack, self._reset))
+				setattr(self, name, Colour(code_to_chars(value), self._stack, self._reset))
 
 
 class AnsiCursor:
@@ -202,6 +221,7 @@ class AnsiFore(AnsiCodes):
 	ANSI Colour Codes for foreground colour.
 
 	Valid values are:
+
 	* BLACK
 	* RED
 	* GREEN
@@ -250,6 +270,7 @@ class AnsiBack(AnsiCodes):
 	ANSI Colour Codes for background colour.
 
 	Valid values are:
+
 	* BLACK
 	* RED
 	* GREEN
@@ -298,6 +319,7 @@ class AnsiStyle(AnsiCodes):
 	ANSI Colour Codes for text style.
 
 	Valid values are:
+
 	* BRIGHT
 	* DIM
 	* NORMAL
@@ -323,5 +345,3 @@ class AnsiStyle(AnsiCodes):
 fore_stack.append(Fore.RESET)
 back_stack.append(Back.RESET)
 style_stack.append(Style.NORMAL)
-
-Fore.GREEN("Hello World")