Skip to content

Commit ab2aed1

Browse files
nasa-ddallenasa-ddalle
committed
Update autodoc to make sure JSON sections have name of option be prescribed
1 parent ec64f29 commit ab2aed1

File tree

144 files changed

+367
-851
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

144 files changed

+367
-851
lines changed

‎cape/autodoc/__init__.py‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,14 @@
4141
"recurse": False,
4242
"verbose": False,
4343
},
44+
"pyfun": {
45+
"folder": OPT_DIRS["pyfun"],
46+
"file": "index",
47+
"module": "cape.pyfun.options",
48+
"class": "Options",
49+
"recurse": False,
50+
"verbose": False,
51+
}
4452
}
4553

4654

‎cape/cfdx/options/reportopts.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,7 @@ class SubfigOpts(OptionsDict):
418418
__slots__ = ()
419419

420420
# Name
421-
_name = "subfigure"
421+
_name = "definitions for a generic report subfigure"
422422

423423
# Additional options
424424
_optlist = (
@@ -1517,7 +1517,7 @@ class TecplotSubfigOpts(SubfigOpts):
15171517
"ActiveFieldMaps": str,
15181518
"ColorMaps": dict,
15191519
"ContourLevels": dict,
1520-
"FieldMap": (INT_TYPES, str),
1520+
"FieldMap": INT_TYPES + (str,),
15211521
"FigWidth": INT_TYPES,
15221522
"Keys": dict,
15231523
"Layout": str,
@@ -1643,7 +1643,7 @@ class SubfigCollectionOpts(OptionsDict):
16431643
__slots__ = ()
16441644

16451645
# Name of things within this section
1646-
_name = "list of subfigure definitions"
1646+
_name = "``Subfigures``: dict of subfigure definitions"
16471647
_subsec_name = "subfigure"
16481648
_label = "cape-json-reportsubfigure"
16491649

‎cape/gruvoc/cli.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
r"""
2+
:mod:`cape.gruvoc.cli`: Command-line interface for CAPE grid conversions
3+
=========================================================================
4+
5+
This module defines the CLI for ``gruvoc`` and
6+
7+
.. code-block:: console
8+
9+
$ python3 -m cape.gruvoc
10+
"""
111

212
# Local imports
313
from .errors import GruvocError

‎cape/optdict/__init__.py‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4363,7 +4363,7 @@ def print_rst(cls, **kw) -> str:
43634363
# 1. kw["title"]
43644364
# 2. cls.__dict__["_name"]
43654365
# 3. cls.__name__
4366-
title = cls.__dict__.get("_name", kw.get("title", cls.__name__))
4366+
title = kw.get("title", cls.__dict__.get("_name", cls.__name__))
43674367
# Get label for this section
43684368
label = cls.__dict__.get("_label", kw.get("label", ""))
43694369
# Length of title
@@ -4431,7 +4431,7 @@ def print_rst(cls, **kw) -> str:
44314431
# Loop through section map
44324432
for secname, seccls in sec_cls_dict.items():
44334433
# Create default title
4434-
sectitle = f"Options for ``{secname}`` section"
4434+
sectitle = f"``{secname}``"
44354435
# Clear any previos titles
44364436
kw.pop("title", None)
44374437
# Set options to turn on defualt title
@@ -5224,13 +5224,10 @@ def genr8_rst_type_list(opttypes, vdef=None, listdepth=0):
52245224
# Update remaining types
52255225
opttypeset.difference_update(FLOAT_TYPES)
52265226
# Convert each remaining type to a string
5227-
try:
5228-
strtypes = [
5229-
f":class:`{clsj.__name__}`"
5230-
for clsj in opttypeset
5231-
]
5232-
except Exception:
5233-
breakpoint()
5227+
strtypes = [
5228+
f":class:`{clsj.__name__}`"
5229+
for clsj in opttypeset
5230+
]
52345231
# Add types to string
52355232
type_parts.extend(sorted(strtypes))
52365233
# Convert list of types to single string

‎cape/optdict/optdoc.py‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,9 +180,14 @@ def write_rst(cls: type, fname: str, **kw):
180180
"recurse_sec_cls": recurse_sec_cls,
181181
"recurse_sec_clsmap": recurse_sec_clsmap,
182182
}
183+
# Check for a name
184+
name = getattr(cls, "_name", "")
185+
# Create default title
186+
secname = os.path.basename(fname).rsplit('.', 1)[0].rsplit('-', 1)[-1]
187+
title = f"``{secname}``: {name}" if name else f"``{secname}``"
188+
title = name if secname == "index" else title
183189
# Set title if appropriate
184-
if "title" in kw:
185-
kw_rst["title"] = kw.pop("title")
190+
kw_rst["title"] = title
186191
# Get unique files whose source code is part of this class
187192
modlist = _find_cls_modfile(cls, narrow, recurse)
188193
# Get latest mod time

‎cape/pylch/options/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
==============================================================
44
55
This module provides defintions for and an interface to all options that
6-
are unique to :mod:`cape.pylcnh.
6+
are unique to :mod:`cape.pylch`.
77
88
:See also:
99
* :mod:`cape.cfdx.options`

‎doc/api/cfdx/casedata.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
.. automodule:: cape.cfdx.databook
3+
:members:
4+

‎doc/api/cfdx/databook.rst‎

Lines changed: 1 addition & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,4 @@
11

22
.. automodule:: cape.cfdx.databook
3-
:members: ImportPyPlot, get_xlim, get_ylim
3+
:members:
44

5-
Global data book container class
6-
--------------------------------
7-
8-
.. autoclass:: cape.cfdx.databook.DataBook
9-
:members:
10-
11-
Individual data books
12-
---------------------
13-
14-
.. autoclass:: cape.cfdx.databook.DBBase
15-
:members:
16-
17-
.. autoclass:: cape.cfdx.databook.DBComp
18-
:members:
19-
20-
.. autoclass:: cape.cfdx.databook.DBTarget
21-
:members:
22-
23-
.. autoclass:: cape.cfdx.databook.DBTriqFM
24-
:members:
25-
26-
.. autoclass:: cape.cfdx.databook.DBTriqFMComp
27-
:members:
28-
29-
Data book classes for individual cases
30-
--------------------------------------
31-
32-
.. autoclass:: cape.cfdx.databook.CaseData
33-
:members:
34-
35-
.. autoclass:: cape.cfdx.databook.CaseFM
36-
:members:
37-
38-
.. autoclass:: cape.cfdx.databook.CaseResid
39-
:members:
40-
41-
42-
Other :mod:`cape.cfdx.databook` methods
43-
----------------------------------------

‎doc/api/cfdx/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313

1414
cntl
1515
casecntl
16+
casedata
1617
caseutils
1718
casecntlbase
1819
cmdgen

‎doc/api/cfdx/options/databookopts.rst‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
11

22
.. automodule:: cape.cfdx.options.databookopts
3+
:members:
34

4-
.. autoclass:: cape.cfdx.options.databookopts.DataBookOpts
5-
:members:
6-
7-
.. autoclass:: cape.cfdx.options.databookopts.DBTargetOpts
8-
:members:

0 commit comments

Comments
 (0)