Updated apidoc files for web

Signed-off-by: Ian Bell <ian.h.bell@gmail.com>
2026-04-23 03:00:17 -04:00 · 2014-09-24 15:58:38 +02:00
parent 320907b946
commit 9e8a925c10
33 changed files with 257 additions and 106 deletions
--- a/Web/apidoc/AbstractState.rst
+++ b/Web/apidoc/AbstractState.rst
@@ -1,6 +0,0 @@
-AbstractState Module
-====================
-
-.. automodule:: CoolProp.AbstractState 
-    :members: AbstractState
-    :undoc-members:  
--- a/Web/apidoc/CoolProp.BibtexParser.rst
+++ b/Web/apidoc/CoolProp.BibtexParser.rst
@@ -0,0 +1,7 @@
+CoolProp.BibtexParser module
+============================
+
+.. automodule:: CoolProp.BibtexParser
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.CoolProp.rst
+++ b/Web/apidoc/CoolProp.CoolProp.rst
@@ -0,0 +1,7 @@
+CoolProp.CoolProp module
+========================
+
+.. automodule:: CoolProp.CoolProp
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.GUI.CoolPropGUI.rst
+++ b/Web/apidoc/CoolProp.GUI.CoolPropGUI.rst
@@ -0,0 +1,7 @@
+CoolProp.GUI.CoolPropGUI module
+===============================
+
+.. automodule:: CoolProp.GUI.CoolPropGUI
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.GUI.PsychScript.rst
+++ b/Web/apidoc/CoolProp.GUI.PsychScript.rst
@@ -0,0 +1,7 @@
+CoolProp.GUI.PsychScript module
+===============================
+
+.. automodule:: CoolProp.GUI.PsychScript
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.GUI.rst
+++ b/Web/apidoc/CoolProp.GUI.rst
@@ -0,0 +1,18 @@
+CoolProp.GUI package
+====================
+
+Submodules
+----------
+
+.. toctree::
+
+   CoolProp.GUI.CoolPropGUI
+   CoolProp.GUI.PsychScript
+
+Module contents
+---------------
+
+.. automodule:: CoolProp.GUI
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.HumidAirProp.rst
+++ b/Web/apidoc/CoolProp.HumidAirProp.rst
@@ -0,0 +1,7 @@
+CoolProp.HumidAirProp module
+============================
+
+.. automodule:: CoolProp.HumidAirProp
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.Plots.Common.rst
+++ b/Web/apidoc/CoolProp.Plots.Common.rst
@@ -0,0 +1,7 @@
+CoolProp.Plots.Common module
+============================
+
+.. automodule:: CoolProp.Plots.Common
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.Plots.Plots.rst
+++ b/Web/apidoc/CoolProp.Plots.Plots.rst
@@ -0,0 +1,7 @@
+CoolProp.Plots.Plots module
+===========================
+
+.. automodule:: CoolProp.Plots.Plots
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.Plots.PsychChart.rst
+++ b/Web/apidoc/CoolProp.Plots.PsychChart.rst
@@ -0,0 +1,7 @@
+CoolProp.Plots.PsychChart module
+================================
+
+.. automodule:: CoolProp.Plots.PsychChart
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.Plots.PsychScript.rst
+++ b/Web/apidoc/CoolProp.Plots.PsychScript.rst
@@ -0,0 +1,7 @@
+CoolProp.Plots.PsychScript module
+=================================
+
+.. automodule:: CoolProp.Plots.PsychScript
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.Plots.SimpleCycles.rst
+++ b/Web/apidoc/CoolProp.Plots.SimpleCycles.rst
@@ -0,0 +1,7 @@
+CoolProp.Plots.SimpleCycles module
+==================================
+
+.. automodule:: CoolProp.Plots.SimpleCycles
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.Plots.Tests.rst
+++ b/Web/apidoc/CoolProp.Plots.Tests.rst
@@ -0,0 +1,7 @@
+CoolProp.Plots.Tests module
+===========================
+
+.. automodule:: CoolProp.Plots.Tests
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.Plots.rst
+++ b/Web/apidoc/CoolProp.Plots.rst
@@ -1,35 +1,22 @@
-Plots Package
-=============
+CoolProp.Plots package
+======================

-:mod:`Plots` Package
--------------------
+Submodules
+----------
+
+.. toctree::
+
+   CoolProp.Plots.Common
+   CoolProp.Plots.Plots
+   CoolProp.Plots.PsychChart
+   CoolProp.Plots.PsychScript
+   CoolProp.Plots.SimpleCycles
+   CoolProp.Plots.Tests
+
+Module contents
+---------------

 .. automodule:: CoolProp.Plots
    :members:
    :undoc-members:
    :show-inheritance:
-
-:mod:`Plots` Module
-------------------
-
-.. automodule:: CoolProp.Plots.Plots
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`PsychChart` Module
------------------------
-
-.. automodule:: CoolProp.Plots.PsychChart
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`SimpleCycles` Module
--------------------------
-
-.. automodule:: CoolProp.Plots.SimpleCycles
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
--- a/Web/apidoc/CoolProp.State.rst
+++ b/Web/apidoc/CoolProp.State.rst
@@ -0,0 +1,7 @@
+CoolProp.State module
+=====================
+
+.. automodule:: CoolProp.State
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.constants.rst
+++ b/Web/apidoc/CoolProp.constants.rst
@@ -0,0 +1,7 @@
+CoolProp.constants module
+=========================
+
+.. automodule:: CoolProp.constants
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.rst
+++ b/Web/apidoc/CoolProp.rst
@@ -1,9 +1,32 @@
-CoolProp Module
-===============
+CoolProp package
+================

-.. automodule:: CoolProp.CoolProp 
-    :synopsis:
+Subpackages
+-----------
+
+.. toctree::
+
+    CoolProp.GUI
+    CoolProp.Plots
+    CoolProp.tests
+
+Submodules
+----------
+
+.. toctree::
+
+   CoolProp.BibtexParser
+   CoolProp.CoolProp
+   CoolProp.CoolProp
+   CoolProp.HumidAirProp
+   CoolProp.State
+   CoolProp.constants
+   CoolProp.constants
+
+Module contents
+---------------
+
+.. automodule:: CoolProp
    :members:
    :undoc-members:
    :show-inheritance:
-    :exclude-members: State,HAProps,HAProps_Aux,PureFluidClass
--- a/Web/apidoc/CoolProp.tests.rst
+++ b/Web/apidoc/CoolProp.tests.rst
@@ -0,0 +1,27 @@
+CoolProp.tests package
+======================
+
+Submodules
+----------
+
+.. toctree::
+
+   CoolProp.tests.runner
+   CoolProp.tests.test_CoolPropState
+   CoolProp.tests.test_HAProps
+   CoolProp.tests.test_Props
+   CoolProp.tests.test_Props1
+   CoolProp.tests.test_Saturation
+   CoolProp.tests.test_State
+   CoolProp.tests.test_Units_CPState
+   CoolProp.tests.test_consistency
+   CoolProp.tests.test_param_getters
+   CoolProp.tests.test_plots
+
+Module contents
+---------------
+
+.. automodule:: CoolProp.tests
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.tests.runner.rst
+++ b/Web/apidoc/CoolProp.tests.runner.rst
@@ -0,0 +1,7 @@
+CoolProp.tests.runner module
+============================
+
+.. automodule:: CoolProp.tests.runner
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.tests.test_CoolPropState.rst
+++ b/Web/apidoc/CoolProp.tests.test_CoolPropState.rst
@@ -0,0 +1,7 @@
+CoolProp.tests.test_CoolPropState module
+========================================
+
+.. automodule:: CoolProp.tests.test_CoolPropState
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.tests.test_HAProps.rst
+++ b/Web/apidoc/CoolProp.tests.test_HAProps.rst
@@ -0,0 +1,7 @@
+CoolProp.tests.test_HAProps module
+==================================
+
+.. automodule:: CoolProp.tests.test_HAProps
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.tests.test_Props.rst
+++ b/Web/apidoc/CoolProp.tests.test_Props.rst
@@ -0,0 +1,7 @@
+CoolProp.tests.test_Props module
+================================
+
+.. automodule:: CoolProp.tests.test_Props
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.tests.test_Props1.rst
+++ b/Web/apidoc/CoolProp.tests.test_Props1.rst
@@ -0,0 +1,7 @@
+CoolProp.tests.test_Props1 module
+=================================
+
+.. automodule:: CoolProp.tests.test_Props1
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.tests.test_Saturation.rst
+++ b/Web/apidoc/CoolProp.tests.test_Saturation.rst
@@ -0,0 +1,7 @@
+CoolProp.tests.test_Saturation module
+=====================================
+
+.. automodule:: CoolProp.tests.test_Saturation
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.tests.test_State.rst
+++ b/Web/apidoc/CoolProp.tests.test_State.rst
@@ -0,0 +1,7 @@
+CoolProp.tests.test_State module
+================================
+
+.. automodule:: CoolProp.tests.test_State
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.tests.test_Units_CPState.rst
+++ b/Web/apidoc/CoolProp.tests.test_Units_CPState.rst
@@ -0,0 +1,7 @@
+CoolProp.tests.test_Units_CPState module
+========================================
+
+.. automodule:: CoolProp.tests.test_Units_CPState
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.tests.test_consistency.rst
+++ b/Web/apidoc/CoolProp.tests.test_consistency.rst
@@ -0,0 +1,7 @@
+CoolProp.tests.test_consistency module
+======================================
+
+.. automodule:: CoolProp.tests.test_consistency
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.tests.test_param_getters.rst
+++ b/Web/apidoc/CoolProp.tests.test_param_getters.rst
@@ -0,0 +1,7 @@
+CoolProp.tests.test_param_getters module
+========================================
+
+.. automodule:: CoolProp.tests.test_param_getters
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/CoolProp.tests.test_plots.rst
+++ b/Web/apidoc/CoolProp.tests.test_plots.rst
@@ -0,0 +1,7 @@
+CoolProp.tests.test_plots module
+================================
+
+.. automodule:: CoolProp.tests.test_plots
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/Web/apidoc/HumidAirProp.rst
+++ b/Web/apidoc/HumidAirProp.rst
@@ -1,7 +0,0 @@
-HumidAirProp Module
-===================
-
-.. automodule:: CoolProp.HumidAirProp
-    :members: HAProps, HAProps_Aux
-    :undoc-members:
-    :show-inheritance:
--- a/Web/apidoc/Plots.rst
+++ b/Web/apidoc/Plots.rst
@@ -1,42 +0,0 @@
-Plots Package
-=============
-
-:mod:`CoolProp.Plots` Package
-----------------------------
-
-.. automodule:: CoolProp.Plots
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`CoolProp.Plots.Common` Module
-------------------------------------
-
-.. automodule:: CoolProp.Plots.Common
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`CoolProp.Plots.Plots` Module
----------------------------------
-
-.. automodule:: CoolProp.Plots.Plots
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`CoolProp.Plots.PsychChart` Module
---------------------------------------
-
-.. automodule:: CoolProp.Plots.PsychChart
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`SimpleCycles` Module
--------------------------
-
-.. automodule:: CoolProp.Plots.SimpleCycles
-    :members:
-    :undoc-members:
-    :show-inheritance:
--- a/Web/apidoc/State.rst
+++ b/Web/apidoc/State.rst
@@ -1,6 +0,0 @@
-State Module
-============
-
-.. automodule:: CoolProp.State 
-    :members: State, PureFluidClass
-    :undoc-members:
--- a/Web/apidoc/modules.rst
+++ b/Web/apidoc/modules.rst
@@ -1,11 +0,0 @@
-CoolProp API
-============
-
-.. toctree::
-   :maxdepth: 4
-
-   CoolProp
-   HumidAirProp
-   Plots
-   State
-   AbstractState