fix doctest, docs

Author: wingechr

.ruff.toml

@@ -13,6 +13,7 @@ ignore = [
   "D401", # non-imperative-mood
   "D403", # first-word-uncapitalized
   "D415", # missing-terminal-punctuation
+  "D412", # otherwise docstring tests will be badly formatted - we need empty line
   #"S101", # assert
   "S113", # request-without-timeout
   "S310", # suspicious-url-open-usage

datatools/__init__.py

@@ -5,11 +5,17 @@
 __all__ = []
 
 
-def test():
-    """Example:
+def self_check():
+    """check that setup is working.
 
-    >>> test()
-    True
+    Example:
+
+        >>> self_check()
+        True
 
     """
     return True
+
+
+# self check on import
+self_check()

docs/03_api.md docs/api.mddocs/03_api.md renamed to docs/api.md

@@ -1,6 +1,6 @@
 """Example script."""
 
-from datatools import test
+from datatools import self_check
 
-if not test():
+if not self_check():
     raise Exception()

docs/02_example.md docs/example.mddocs/02_example.md renamed to docs/example.md

@@ -1,3 +1 @@
-# README
-
 --8<-- "README.md"

docs/example.py

@@ -37,7 +37,7 @@ plugins:
         python:
           # either install package or provide path here
           # relative to from inside docs/ foldler (example.py)
-          paths: ["../datatools"]
+          #paths: ["../datatools"]
           options:
             filters:
               - "!^_[^_]"
@@ -50,3 +50,8 @@ plugins:
             show_signature_annotations: true
   - search:
       lang: en
+
+nav:
+  - index.md
+  - example.md
+  - api.md

docs/01_index.md docs/index.mddocs/01_index.md renamed to docs/index.md

@@ -26,4 +26,4 @@ def test_docs_example_py(self):
 
     def test_main_test(self):
         """Run tets() function from main"""
-        self.assertTrue(datatools.test())
+        self.assertTrue(datatools.self_check())