add another function so we can skip and include in a test case

astropy · Dec 28, 2021 · f75b44d · f75b44d
1 parent 57a8360
commit f75b44d
Show file tree

Hide file tree

Showing 11 changed files with 19 additions and 2 deletions.
diff --git a/sphinx_automodapi/tests/cases/func_headings/output/index.rst.automodsumm b/sphinx_automodapi/tests/cases/func_headings/output/index.rst.automodsumm
@@ -6,3 +6,4 @@
     add
     subtract
     multiply
+    divide
diff --git a/sphinx_automodapi/tests/cases/func_noheading/output/index.rst.automodsumm b/sphinx_automodapi/tests/cases/func_noheading/output/index.rst.automodsumm
@@ -6,3 +6,4 @@
     add
     subtract
     multiply
+    divide
diff --git a/sphinx_automodapi/tests/cases/func_nomaindocstring/output/index.rst.automodsumm b/sphinx_automodapi/tests/cases/func_nomaindocstring/output/index.rst.automodsumm
@@ -6,3 +6,4 @@
     add
     subtract
     multiply
+    divide
diff --git a/sphinx_automodapi/tests/cases/func_simple/output/index.rst.automodsumm b/sphinx_automodapi/tests/cases/func_simple/output/index.rst.automodsumm
@@ -6,3 +6,4 @@
     add
     subtract
     multiply
+    divide
diff --git a/sphinx_automodapi/tests/cases/mixed_toplevel/output/index.rst.automodsumm b/sphinx_automodapi/tests/cases/mixed_toplevel/output/index.rst.automodsumm
@@ -4,6 +4,7 @@
     :toctree: api
 
     add
+    divide
     multiply
     subtract
 .. currentmodule:: sphinx_automodapi.tests.example_module

diff --git a/sphinx_automodapi/tests/cases/mixed_toplevel_all_objects/output/index.rst.automodsumm b/sphinx_automodapi/tests/cases/mixed_toplevel_all_objects/output/index.rst.automodsumm
@@ -4,6 +4,7 @@
     :toctree: api
 
     add
+    divide
     multiply
     subtract
 .. currentmodule:: sphinx_automodapi.tests.example_module

diff --git a/sphinx_automodapi/tests/cases/mixed_toplevel_nodiagram/output/index.rst.automodsumm b/sphinx_automodapi/tests/cases/mixed_toplevel_nodiagram/output/index.rst.automodsumm
@@ -4,6 +4,7 @@
     :toctree: api
 
     add
+    divide
     multiply
     subtract
 .. currentmodule:: sphinx_automodapi.tests.example_module

diff --git a/sphinx_automodapi/tests/cases/non_ascii/output/index.rst.automodsumm b/sphinx_automodapi/tests/cases/non_ascii/output/index.rst.automodsumm
@@ -6,3 +6,4 @@
     add
     subtract
     multiply
+    divide
diff --git a/sphinx_automodapi/tests/cases/source_dir/output/src/index.rst.automodsumm b/sphinx_automodapi/tests/cases/source_dir/output/src/index.rst.automodsumm
@@ -6,3 +6,4 @@
     add
     subtract
     multiply
+    divide
diff --git a/sphinx_automodapi/tests/example_module/functions.py b/sphinx_automodapi/tests/example_module/functions.py
@@ -2,7 +2,7 @@
 A collection of useful functions
 """
 
-__all__ = ['add', 'subtract', 'multiply']
+__all__ = ['add', 'subtract', 'multiply', 'divide']
 
 
 def add(a, b):
@@ -24,3 +24,10 @@ def multiply(c, d):
     Multiply two numbers
     """
     return c * d
+
+
+def divide(c, d):
+    """
+    Divide two numbers
+    """
+    return c / d
diff --git a/sphinx_automodapi/tests/test_automodapi.py b/sphinx_automodapi/tests/test_automodapi.py
@@ -384,6 +384,7 @@ def test_am_replacer_skip_stdlib(tmpdir):
 .. automodapi:: sphinx_automodapi.tests.example_module.functions
     :include: add
     :include: subtract
+    :skip: divide
 
 This comes after
 """
@@ -403,7 +404,7 @@ def test_am_replacer_skip_stdlib(tmpdir):
 .. automodsumm:: sphinx_automodapi.tests.example_module.functions
     :functions-only:
     :toctree: api
-    :skip: multiply
+    :skip: divide,multiply
 
 
 This comes after