Docs and doc generation updated for the restructuring
This commit is contained in:
parent
93f6d88cd4
commit
2f5cad3d05
|
@ -1,5 +1,5 @@
|
|||
# gaspype.FloatArray
|
||||
# gaspype.typing.FloatArray
|
||||
|
||||
```{eval-rst}
|
||||
.. autoclass:: gaspype.FloatArray
|
||||
.. autoclass:: gaspype.typing.FloatArray
|
||||
```
|
|
@ -17,8 +17,7 @@ def write_classes(f: TextIOWrapper, patterns: list[str], module_name: str, title
|
|||
|
||||
classes = [
|
||||
name for name, obj in inspect.getmembers(module, inspect.isclass)
|
||||
if (obj.__module__ == module_name and
|
||||
any(fnmatch.fnmatch(name, pat) for pat in patterns if pat not in exclude) and
|
||||
if (any(fnmatch.fnmatch(name, pat) for pat in patterns if pat not in exclude) and
|
||||
obj.__doc__ and '(Automatic generated stub)' not in obj.__doc__)
|
||||
]
|
||||
|
||||
|
@ -45,8 +44,7 @@ def write_functions(f: TextIOWrapper, patterns: list[str], module_name: str, tit
|
|||
|
||||
functions = [
|
||||
name for name, obj in inspect.getmembers(module, inspect.isfunction)
|
||||
if (obj.__module__ == module_name and
|
||||
any(fnmatch.fnmatch(name, pat) for pat in patterns if pat not in exclude))
|
||||
if (any(fnmatch.fnmatch(name, pat) for pat in patterns if pat not in exclude))
|
||||
]
|
||||
|
||||
if description:
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
# gaspype.NDFloat
|
||||
# gaspype.typing.NDFloat
|
||||
|
||||
```{eval-rst}
|
||||
.. autoclass:: gaspype.NDFloat
|
||||
.. autoclass:: gaspype.typing.NDFloat
|
||||
```
|
|
@ -22,6 +22,7 @@ def test_elements():
|
|||
df = pd.DataFrame(list(gp.elements(fl * np.array([1, 2, 3, 4]))))
|
||||
assert df.shape == (4, 2)
|
||||
|
||||
|
||||
def test_iter():
|
||||
fl = gp.fluid({'O2': 1, 'H2': 2, 'H2O': 3})
|
||||
|
||||
|
|
Loading…
Reference in New Issue