Added test case for importing a class from a private submodule into a…

… public one
astropy · Sep 11, 2024 · e689b14 · e689b14
1 parent 7e5e6fa
commit e689b14
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 0 deletions.
diff --git a/sphinx_automodapi/tests/cases/public_from_private/README.md b/sphinx_automodapi/tests/cases/public_from_private/README.md
@@ -0,0 +1,2 @@
+Importing a class from a private submodule to a public submodule
+at the same level of hierarchy in the module.
diff --git a/sphinx_automodapi/tests/cases/public_from_private/input/index.rst b/sphinx_automodapi/tests/cases/public_from_private/input/index.rst
@@ -0,0 +1 @@
+.. automodapi:: sphinx_automodapi.tests.example_module.public
diff --git a/...om_private/output/api/sphinx_automodapi.tests.example_module.public.Camelot.rst b/...om_private/output/api/sphinx_automodapi.tests.example_module.public.Camelot.rst
@@ -0,0 +1,7 @@
+Camelot
+=======
+
+.. currentmodule:: sphinx_automodapi.tests.example_module.public
+
+.. autoclass:: Camelot
+   :show-inheritance:
diff --git a/sphinx_automodapi/tests/cases/public_from_private/output/index.rst.automodapi b/sphinx_automodapi/tests/cases/public_from_private/output/index.rst.automodapi
@@ -0,0 +1,19 @@
+
+sphinx_automodapi.tests.example_module.public Module
+----------------------------------------------------
+
+.. automodule:: sphinx_automodapi.tests.example_module.public
+
+Classes
+^^^^^^^
+
+.. automodsumm:: sphinx_automodapi.tests.example_module.public
+    :classes-only:
+    :toctree: api
+
+Class Inheritance Diagram
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automod-diagram:: sphinx_automodapi.tests.example_module.public
+    :private-bases:
+    :parts: 1
diff --git a/sphinx_automodapi/tests/cases/public_from_private/output/index.rst.automodsumm b/sphinx_automodapi/tests/cases/public_from_private/output/index.rst.automodsumm
@@ -0,0 +1,7 @@
+.. currentmodule:: sphinx_automodapi.tests.example_module.public
+
+.. autosummary::
+    :toctree: api
+
+    Camelot
+
diff --git a/sphinx_automodapi/tests/example_module/_private.py b/sphinx_automodapi/tests/example_module/_private.py
@@ -0,0 +1,4 @@
+class Camelot:
+    """
+    It's a silly place anyway
+    """
diff --git a/sphinx_automodapi/tests/example_module/public.py b/sphinx_automodapi/tests/example_module/public.py
@@ -0,0 +1 @@
+from ._private import Camelot
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Importing a class from a private submodule to a public submodule
		at the same level of hierarchy in the module.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		.. automodapi:: sphinx_automodapi.tests.example_module.public