Add autogeneration of documentation of equipment module

.gitignore

@@ -102,6 +102,8 @@ docs/lib.thread.rst
 docs/lib.unidades.rst
 docs/lib.utilities.rst
 
+docs/equipment.*.rst
+
 # Script propios
 .script/
 iapws

docs/equipment.rst

@@ -0,0 +1,8 @@
+equipment package
+=================
+
+.. automodule:: equipment
+
+
+.. toctree::
+    :maxdepth: 2

docs/generateReferences.py

@@ -1,15 +1,37 @@
 #!/usr/bin/python3
 # -*- coding: utf-8 -*-
 
-# Generate the *-ref.rst files with list of references
+"""Module autogeneration of documentation files. This script autogenerate the
+lib.*.rst and equipment.*.rst files with the automodule schema
+
+lib.? module
+====================
+
+.. automodule:: lib.?
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :member-order: bysource
+
+.. include:: lib.*_ref.rst
+
+Furthermore autogenerate the lib.*_ref.rst files with a list of bibliographic
+references used in the module
+"""
+
+import glob
+from os.path import basename, splitext
 
 import lib
+import equipment
+
+total = []
 
-all = lib.__all__ 
+all = lib.__all__
 # for mod in lib.EoS.__all__:
     # all.append(".".join(mod.__name__.split(".")[1:]))
 
-total = []
+# library module autogeneration
 for library in all:
     if library in ["EoS", "mEoS"]:
         continue
@@ -33,10 +55,12 @@
         print("    :show-inheritance:", file=file)
         print("    :member-order: bysource", file=file)
 
+        # Add the *-ref.rst file to lib.*.rst file if it's available
         if hasattr(module, "__doi__") and module.__doi__:
             print("", file=file)
             print(".. include:: lib.%s_ref.rst" % library, file=file)
 
+    # Generate the *-ref.rst files with list of references
     if hasattr(module, "__doi__") and module.__doi__:
         with open("docs/lib.%s_ref.rst" % library, "w") as file:
             print("References", file=file)
@@ -45,3 +69,22 @@
                 id = str(id)
                 print(".. [%s] %s; %s. %s" % (
                     id, rf["autor"], rf["title"], rf["ref"]), file=file)
+
+# equipment module autogeneration
+lst = glob.glob("./equipment/[!^UI|__]*.py")
+for mod in lst:
+    library = splitext(basename(mod))[0]
+
+    __import__("equipment.%s" % library)
+    module = equipment.__getattribute__(library)
+
+    # Make equipment.rst schemas
+    with open("docs/equipment.%s.rst" % library, "w") as file:
+        print("equipment.%s module" % library, file=file)
+        print("="*(len(library)+10+7), file=file)
+        print("", file=file)
+        print(".. automodule:: equipment.%s" % library, file=file)
+        print("    :members:", file=file)
+        print("    :undoc-members:", file=file)
+        print("    :show-inheritance:", file=file)
+        print("    :member-order: bysource", file=file)

docs/modules.rst

@@ -4,5 +4,6 @@ API reference
 .. toctree::
    :maxdepth: 4
 
+   equipment
    lib
    tools