mirror of
https://github.com/Cantera/cantera.git
synced 2026-08-09 04:28:30 -05:00
[Doc/Python] Add explicit signatures for Cython class constructors
Sphinx is not able to read the signature for the init method of Cython's cdef classes. Fixes #1635
This commit is contained in:
@@ -11,11 +11,11 @@ Kinetics Managers
|
||||
|
||||
Kinetics
|
||||
^^^^^^^^
|
||||
.. autoclass:: Kinetics
|
||||
.. autoclass:: Kinetics()
|
||||
|
||||
InterfaceKinetics
|
||||
^^^^^^^^^^^^^^^^^
|
||||
.. autoclass:: InterfaceKinetics
|
||||
.. autoclass:: InterfaceKinetics()
|
||||
|
||||
Reactions
|
||||
---------
|
||||
@@ -25,7 +25,7 @@ This class contains the definition of a single reaction, independent of a specif
|
||||
|
||||
Reaction
|
||||
^^^^^^^^
|
||||
.. autoclass:: Reaction
|
||||
.. autoclass:: Reaction(reactants=None, products=None, rate=None, *, equation=None, init=True, third_body=None)
|
||||
:no-undoc-members:
|
||||
|
||||
|
||||
@@ -103,7 +103,7 @@ ExtensibleRate
|
||||
|
||||
InterfaceRateBase
|
||||
^^^^^^^^^^^^^^^^^
|
||||
.. autoclass:: InterfaceRateBase
|
||||
.. autoclass:: InterfaceRateBase()
|
||||
:no-undoc-members:
|
||||
|
||||
InterfaceArrheniusRate
|
||||
@@ -118,7 +118,7 @@ InterfaceBlowersMaselRate
|
||||
|
||||
StickRateBase
|
||||
^^^^^^^^^^^^^
|
||||
.. autoclass:: StickRateBase
|
||||
.. autoclass:: StickRateBase()
|
||||
:no-undoc-members:
|
||||
|
||||
StickingArrheniusRate
|
||||
@@ -136,12 +136,12 @@ Auxiliary Reaction Data
|
||||
|
||||
ExtensibleRateData
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
.. autoclass:: ExtensibleRateData
|
||||
.. autoclass:: ExtensibleRateData()
|
||||
:no-undoc-members:
|
||||
|
||||
ThirdBody
|
||||
^^^^^^^^^
|
||||
.. autoclass:: ThirdBody
|
||||
.. autoclass:: ThirdBody(collider="M", *, efficiencies=None, default_efficiency=None)
|
||||
:no-undoc-members:
|
||||
|
||||
Arrhenius
|
||||
@@ -153,4 +153,4 @@ Reaction Path Analysis
|
||||
|
||||
ReactionPathDiagram
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
.. autoclass:: ReactionPathDiagram(Kinetics kin, str element)
|
||||
.. autoclass:: ReactionPathDiagram(kin: Kinetics, element: str)
|
||||
|
||||
@@ -32,7 +32,7 @@ Mixture
|
||||
Species
|
||||
-------
|
||||
|
||||
.. autoclass:: Species
|
||||
.. autoclass:: Species(name=None, composition=None, charge=None, size=None, init=True)
|
||||
|
||||
Species Thermodynamic Properties
|
||||
--------------------------------
|
||||
@@ -72,7 +72,7 @@ ShomatePoly2
|
||||
Element
|
||||
-------
|
||||
|
||||
.. autoclass:: Element
|
||||
.. autoclass:: Element(name_or_symbol_or_atomic_number)
|
||||
:no-undoc-members:
|
||||
|
||||
.. autoattribute:: num_elements_defined
|
||||
|
||||
@@ -12,23 +12,23 @@ YAML Input/Output
|
||||
AnyMap
|
||||
^^^^^^
|
||||
|
||||
.. autoclass:: AnyMap
|
||||
.. autoclass:: AnyMap()
|
||||
|
||||
YamlWriter
|
||||
^^^^^^^^^^
|
||||
.. autoclass:: YamlWriter
|
||||
.. autoclass:: YamlWriter()
|
||||
|
||||
Unit Conversions
|
||||
----------------
|
||||
|
||||
UnitSystem
|
||||
^^^^^^^^^^
|
||||
.. autoclass:: UnitSystem
|
||||
.. autoclass:: UnitSystem(units)
|
||||
:no-undoc-members:
|
||||
|
||||
Units
|
||||
^^^^^
|
||||
.. autoclass:: Units
|
||||
.. autoclass:: Units(name)
|
||||
:no-undoc-members:
|
||||
|
||||
.. _sec-python-global-funcs:
|
||||
|
||||
@@ -11,25 +11,25 @@ Zero-Dimensional Reactor Networks
|
||||
Defining Functions
|
||||
------------------
|
||||
|
||||
.. autoclass:: Func1
|
||||
.. autoclass:: Func1(callable)
|
||||
|
||||
.. autoclass:: Tabulated1
|
||||
.. autoclass:: Tabulated1(time, fval, method='linear')
|
||||
|
||||
Base Classes
|
||||
------------
|
||||
|
||||
ReactorBase
|
||||
^^^^^^^^^^^
|
||||
.. autoclass:: ReactorBase
|
||||
.. autoclass:: ReactorBase()
|
||||
|
||||
FlowDevice
|
||||
^^^^^^^^^^
|
||||
.. autoclass:: FlowDevice
|
||||
.. autoclass:: FlowDevice()
|
||||
|
||||
Reactor Networks
|
||||
----------------
|
||||
|
||||
.. autoclass:: ReactorNet
|
||||
.. autoclass:: ReactorNet(reactors=())
|
||||
|
||||
.. _sec-python-reactors:
|
||||
|
||||
@@ -128,17 +128,17 @@ Flow Controllers
|
||||
|
||||
MassFlowController
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
.. autoclass:: MassFlowController
|
||||
.. autoclass:: MassFlowController(upstream, downstream, *, name=None, mdot=1.0, edge_attr=None)
|
||||
:inherited-members:
|
||||
|
||||
Valve
|
||||
^^^^^
|
||||
.. autoclass:: Valve
|
||||
.. autoclass:: Valve(upstream, downstream, *, name=None, K=1.0, edge_attr=None)
|
||||
:inherited-members:
|
||||
|
||||
PressureController
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
.. autoclass:: PressureController
|
||||
.. autoclass:: PressureController(upstream, downstream, *, name=None, primary=None, K=1.0, edge_attr=None)
|
||||
:inherited-members:
|
||||
|
||||
Preconditioners
|
||||
@@ -146,7 +146,7 @@ Preconditioners
|
||||
|
||||
AdaptivePreconditioner
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
.. autoclass:: AdaptivePreconditioner
|
||||
.. autoclass:: AdaptivePreconditioner()
|
||||
|
||||
Drawing Reactor Networks
|
||||
------------------------
|
||||
|
||||
Reference in New Issue
Block a user