Tests build HTML and parse it to validate structure

docs/changes/+d97c5f48.misc.rst

@@ -0,0 +1 @@
+Tests build HTML output and parse the HTML to validate the output structure.

tests/python/py3example/conf.py

@@ -18,6 +18,7 @@ extensions = ["sphinx.ext.autodoc", "autoapi.extension"]
 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

tests/python/pyautodoc_typehints/example/example.py

@@ -1,6 +1,7 @@
 class A:
     def test(self, a: int) -> bool:
         """Test.
+
         Args:
             a: Argument
         """

tests/python/pyautodoc_typehints/example/example2.py

@@ -1,6 +1,7 @@
 class B:
     def test(self, a: int) -> bool:
         """Test.
+
         Args:
             a: Argument
         """

tests/python/pyexample/autoapi/index.rst

@@ -1,11 +0,0 @@
-API Reference
-=============
-
-This page contains auto-generated API reference documentation [#f1]_.
-
-.. toctree::
-   :titlesonly:
-
-   /autoapi/example/index
-
-.. [#f1] Created with `sphinx-autoapi <https://github.com/readthedocs/sphinx-autoapi>`_

tests/python/pyexample/index.rst

@@ -7,8 +7,9 @@ Welcome to pyexample's documentation!
 =====================================
 
 .. toctree::
+   :glob:
 
-   manualapi
+   *
 
 
 

tests/python/pyexample/manualapi.rst

@@ -3,8 +3,7 @@ Autodoc Directives
 
 .. autoapimodule:: example
     :members:
-    :noindex:
 
 
 .. autoapidecorator:: example.decorator_okay
-   :noindex:
+    :noindex:

tests/python/pyexample/null.rst

@@ -0,0 +1,2 @@
+Null
+====

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

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

tests/python/pymovedconfpy/autoapi/index.rst

@@ -1,11 +0,0 @@
-API Reference
-=============
-
-This page contains auto-generated API reference documentation [#f1]_.
-
-.. toctree::
-   :titlesonly:
-
-   /autoapi/example/index
-
-.. [#f1] Created with `sphinx-autoapi <https://github.com/readthedocs/sphinx-autoapi>`_

tests/python/pypackageexample/conf.py

@@ -18,3 +18,4 @@ extensions = ["autoapi.extension"]
 autoapi_type = "python"
 autoapi_dirs = ["example"]
 autoapi_file_pattern = "*.py"
+autoapi_keep_files = True

tests/python/pypackageexample/example/__init__.py

@@ -1,3 +1,4 @@
+"""This is a docstring."""
 from . import foo
 
 

tests/python/pypackageexample/index.rst

@@ -4,7 +4,7 @@
    contain the root `toctree` directive.
 
 Welcome to pypackageexample's documentation!
-=====================================
+============================================
 
 .. toctree::
 

tox.ini

@@ -22,6 +22,7 @@ extras =
     dotnet
     go
 deps =
+    beautifulsoup4
     pytest
 commands =
     pytest {posargs}