Tests build HTML and parse it to validate structure

AWhetter · AWhetter · commit 99366617719f · 2023-05-25T21:44:47.000-07:00
diff --git a/docs/changes/+d97c5f48.misc.rst b/docs/changes/+d97c5f48.misc.rst
@@ -0,0 +1 @@
+Tests build HTML output and parse the HTML to validate the output structure.
diff --git a/tests/python/py3example/conf.py b/tests/python/py3example/conf.py
@@ -18,6 +18,7 @@
 autoapi_type = "python"
 autoapi_dirs = ["example"]
 autoapi_python_class_content = "both"
+autoapi_keep_files = True
 autoapi_options = [
     "members",
     "undoc-members",  # this is temporary until we add docstrings across the codebase
@@ -26,4 +27,4 @@
     "special-members",
     "imported-members",
     "inherited-members",
-]
+]
diff --git a/tests/python/pyautodoc_typehints/example/example.py b/tests/python/pyautodoc_typehints/example/example.py
@@ -1,6 +1,7 @@
 class A:
     def test(self, a: int) -> bool:
         """Test.
+
         Args:
             a: Argument
         """
diff --git a/tests/python/pyautodoc_typehints/example/example2.py b/tests/python/pyautodoc_typehints/example/example2.py
@@ -1,6 +1,7 @@
 class B:
     def test(self, a: int) -> bool:
         """Test.
+
         Args:
             a: Argument
         """
diff --git a/tests/python/pyexample/autoapi/index.rst b/tests/python/pyexample/autoapi/index.rst
diff --git a/tests/python/pyexample/index.rst b/tests/python/pyexample/index.rst
@@ -7,8 +7,9 @@ Welcome to pyexample's documentation!
 =====================================
 
 .. toctree::
+   :glob:
 
-   manualapi
+   *
 
 
 
diff --git a/tests/python/pyexample/manualapi.rst b/tests/python/pyexample/manualapi.rst
@@ -3,8 +3,7 @@ Autodoc Directives
 
 .. autoapimodule:: example
     :members:
-    :noindex:
 
 
 .. autoapidecorator:: example.decorator_okay
-   :noindex:
+    :noindex:
diff --git a/tests/python/pyexample/null.rst b/tests/python/pyexample/null.rst
@@ -0,0 +1,2 @@
+Null
+====
diff --git a/tests/python/pyiexample/index.rst b/tests/python/pyiexample/index.rst
@@ -1,21 +1,9 @@
-.. pyexample documentation master file, created by
-   sphinx-quickstart on Fri May 29 13:34:37 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to pyexample's documentation!
-=====================================
+Welcome to pyiexample's documentation!
+======================================
 
 .. toctree::
 
    autoapi/index
-   manualapi
-
-Contents:
-
-.. toctree::
-   :maxdepth: 2
-
 
 
 Indices and tables
diff --git a/tests/python/pyiexample2/index.rst b/tests/python/pyiexample2/index.rst
@@ -1,21 +1,9 @@
-.. pyexample documentation master file, created by
-   sphinx-quickstart on Fri May 29 13:34:37 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to pyexample's documentation!
-=====================================
+Welcome to pyiexample2's documentation!
+=======================================
 
 .. toctree::
 
    autoapi/index
-   manualapi
-
-Contents:
-
-.. toctree::
-   :maxdepth: 2
-
 
 
 Indices and tables
diff --git a/tests/python/pymovedconfpy/autoapi/index.rst b/tests/python/pymovedconfpy/autoapi/index.rst
diff --git a/tests/python/pypackageexample/conf.py b/tests/python/pypackageexample/conf.py
@@ -18,3 +18,4 @@
 autoapi_type = "python"
 autoapi_dirs = ["example"]
 autoapi_file_pattern = "*.py"
+autoapi_keep_files = True
diff --git a/tests/python/pypackageexample/example/__init__.py b/tests/python/pypackageexample/example/__init__.py
@@ -1,3 +1,4 @@
+"""This is a docstring."""
 from . import foo
 
 
diff --git a/tests/python/pypackageexample/index.rst b/tests/python/pypackageexample/index.rst
@@ -4,7 +4,7 @@
    contain the root `toctree` directive.
 
 Welcome to pypackageexample's documentation!
-=====================================
+============================================
 
 .. toctree::
 
diff --git a/tests/python/test_pyintegration.py b/tests/python/test_pyintegration.py
diff --git a/tox.ini b/tox.ini

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Tests build HTML output and parse the HTML to validate the output structure.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+"""This is a docstring."""`
`1`	`2`	`from . import foo`
`2`	`3`
`3`	`4`