Fix Sphinx rst warnings (#163)

Author: JSCU-CNI

flow/record/adapter/text.py

@@ -26,6 +26,16 @@
 
 
 class DefaultMissing(dict):
+    """A dictionary subclass that returns a formatted string for missing keys.
+
+    Example:
+        >>> d = DefaultMissing({"foo": "bar"})
+        >>> d['foo']
+        'bar'
+        >>> d['missing_key']
+        '{missing_key}'
+    """
+
     def __missing__(self, key: str) -> str:
         return key.join("{}")
 

tests/docs/Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?= -jauto
+SPHINXOPTS    ?= -jauto -w $(BUILDDIR)/warnings.log --fail-on-warning
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = build

tests/docs/conf.py

@@ -32,3 +32,8 @@
 autodoc_member_order = "groupwise"
 
 autosectionlabel_prefix_document = True
+
+suppress_warnings = [
+    # https://github.com/readthedocs/sphinx-autoapi/issues/285
+    "autoapi.python_import_resolution",
+]