Update autodoc; zero warnings

nasa-ddalle · nasa-ddalle · commit c2654988975b · 2025-09-24T00:59:32.000-07:00
diff --git a/cape/cfdx/casecntl.py b/cape/cfdx/casecntl.py
@@ -4777,6 +4777,7 @@ def check_alt_exit(self, j: Optional[int] = None) -> bool:
             *runner*: :class:`CaseRunner`
                 Controller to run one case of solver
             *j*: {``None``} | :class:`int`
+                Phase index
         :Outputs:
             *q*: :class:`bool`
                 ``True`` if no listed files have been modified recently
@@ -6007,7 +6008,7 @@ def clean(self, test: bool = False):
             *test*: ``True`` | {``False``}
                 Option to log all actions but not actually copy/delete
         :Versions:
-            * 2024-09-18 ``@ddalle`: v1.0
+            * 2024-09-18 ``@ddalle``: v1.0
         """
         # Get archivist
         a = self.get_archivist()
@@ -6027,7 +6028,7 @@ def archive(self, test: bool = False):
             *test*: ``True`` | {``False``}
                 Option to log all actions but not actually copy/delete
         :Versions:
-            * 2024-09-18 ``@ddalle`: v1.0
+            * 2024-09-18 ``@ddalle``: v1.0
         """
         # Get archivist
         a = self.get_archivist()
@@ -6047,7 +6048,7 @@ def skeleton(self, test: bool = False):
             *test*: ``True`` | {``False``}
                 Option to log all actions but not actually copy/delete
         :Versions:
-            * 2024-09-18 ``@ddalle`: v1.0
+            * 2024-09-18 ``@ddalle``: v1.0
         """
         # Get archivist
         a = self.get_archivist()
@@ -6066,7 +6067,7 @@ def unarchive(self, test: bool = False):
             *test*: ``True`` | {``False``}
                 Option to log all actions but not actually copy/delete
         :Versions:
-            * 2024-09-20 ``@ddalle`: v1.0
+            * 2024-09-20 ``@ddalle``: v1.0
         """
         # Get archivist
         a = self.get_archivist()
diff --git a/cape/optdict/__init__.py b/cape/optdict/__init__.py
@@ -1901,6 +1901,7 @@ def get_subopt(self, sec: str, opt: str, key="Type", **kw):
             2
             >>> opts.get_subopt("C", "c")
             3
+
         :Call:
             >>> v = opts.get_subopt(sec, opt, key="Type", **kw)
         :Inputs:
@@ -2112,6 +2113,7 @@ def set_opt(self, opt: str, val, j=None, mode=None):
         self[opt] = val
 
     # Apply option to subsection, if possible
+    @expand_doc
     def set_subopt(
             self,
             sec: str,
diff --git a/cape/pycart/cmdgen.py b/cape/pycart/cmdgen.py
@@ -141,7 +141,7 @@ def autoInputs(opts=None, j=0, **kw):
         *halfBody*: ``True`` | {``False``}
             Create a half-body mesh that starts at ``0`` for one axis
         *symmX*: ``True`` | {``False``}
-            Use *x*=0 for symmetry plane
+            Use *x*\ =0 for symmetry plane
     :Outputs:
         *cmd*: :class:`list`\ [:class:`str`]
             Command split into a list of strings
diff --git a/cape/setup_py/__init__.py b/cape/setup_py/__init__.py
@@ -20,7 +20,7 @@
 # Compile and link
 SETUP_SETTINGS = dict(
     name="cape",
-    version="2.1.2alpha",
+    version="2.2.0",
     description="CAPE computational aerosciences package",
     long_description=LONG_DESCRIPTION,
     url="https://www.github.com/nasa/cape",
diff --git a/doc/api/cape/_cape.rst b/doc/api/cape/_cape.rst
@@ -1,13 +1,13 @@
 
-:mod:`_cape3`: Compiled CAPE extension
+:mod:`_cape`: Compiled CAPE extension
 ===============================================
 
-The :mod:`cape._cape3` module contains methods that were written in C to
+The :mod:`_cape` module contains methods that were written in C to
 increase speed and efficiency. The most commonly utilized methods enable Cape,
 pyCart, etc. to write surface triangulations faster. Because these are simple
 tasks that may need to be repeated many times, creating a compiled version can
 save considerable time. However, Python versions of these methods are also
 included in the main modules.
 
-.. automodule:: _cape3
+.. automodule:: _cape
     :members:
diff --git a/doc/api/cfdx/casecntl.rst b/doc/api/cfdx/casecntl.rst
@@ -2,8 +2,3 @@
 .. automodule:: cape.cfdx.casecntl
     :members: 
 
-.. autoclass:: cape.cfdx.casecntl.CaseRunner
-    :members:
-    :private-members: _archivist_cls, _dex_cls, _logprefix, _modname,
-                      _nstart_max, _progname, _rc_cls, _zombie_files
-
diff --git a/doc/api/cfdx/cntl.rst b/doc/api/cfdx/cntl.rst
@@ -2,8 +2,3 @@
 .. automodule:: cape.cfdx.cntl
     :members:
 
-.. autoclass:: cape.cfdx.cntl.Cntl
-    :members:
-    :private-members: _case_cls, _case_mod, _databook_mod, _fjson_default,
-                      _name, _opts_cls, _report_mod, _solver,
-                      _warnmode_default, _warnmode_envvar, _zombie_files
diff --git a/doc/api/pylch/databook.rst b/doc/api/pylch/databook.rst
@@ -0,0 +1,4 @@
+
+.. automodule:: cape.pylch.databook
+    :members:
+

Original file line number	Diff line number	Diff line change
`@@ -1901,6 +1901,7 @@ def get_subopt(self, sec: str, opt: str, key="Type", **kw):`
`1901`	`1901`	`2`
`1902`	`1902`	`>>> opts.get_subopt("C", "c")`
`1903`	`1903`	`3`
	`1904`	`+`
`1904`	`1905`	`:Call:`
`1905`	`1906`	`>>> v = opts.get_subopt(sec, opt, key="Type", **kw)`
`1906`	`1907`	`:Inputs:`
`@@ -2112,6 +2113,7 @@ def set_opt(self, opt: str, val, j=None, mode=None):`
`2112`	`2113`	`self[opt] = val`
`2113`	`2114`
`2114`	`2115`	`# Apply option to subsection, if possible`
	`2116`	`+ @expand_doc`
`2115`	`2117`	`def set_subopt(`
`2116`	`2118`	`self,`
`2117`	`2119`	`sec: str,`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
++
 +.. automodule:: cape.pylch.databook
 +    :members:
++