mirror of
https://github.com/CoolProp/CoolProp.git
synced 2026-01-10 14:38:11 -05:00
Added the Python module to the docs again
This commit is contained in:
@@ -1,23 +1,23 @@
|
||||
.. CoolProp documentation file
|
||||
|
||||
|
||||
*********************
|
||||
Welcome to CoolProp
|
||||
*********************
|
||||
*********************
|
||||
|
||||
CoolProp is an open-source database of fluid and humid air properties, formulated based on the most accurate formulations in open literature. It has been validated against the most accurate data available from the relevant references.
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
|
||||
citation.rst
|
||||
|
||||
apidoc/CoolProp.rst
|
||||
|
||||
.. toctree::
|
||||
|
||||
|
||||
general_information.rst
|
||||
online/index.rst
|
||||
fluid_properties/index.rst
|
||||
coolprop/index.rst
|
||||
develop/index.rst
|
||||
apidoc/modules.rst
|
||||
|
||||
.. :maxdepth: 2
|
||||
@@ -103,3 +103,10 @@ Once installed, you can use CoolProp for various things:
|
||||
.. _3D stuff: https://github.com/CoolProp/CoolProp/blob/master/dev/TTSE/TTSE_ranges.py
|
||||
|
||||
|
||||
Module Documentation
|
||||
====================
|
||||
|
||||
.. toctree::
|
||||
|
||||
../../../apidoc/CoolProp.rst
|
||||
|
||||
|
||||
@@ -242,7 +242,7 @@ def websiteFactory(platform, gitMode='incremental', fullBuild=False):
|
||||
# Run doxygen build
|
||||
factory.addStep(ShellCommand(command=' '.join([docActivateCmd(), "doxygen", "--version", "&&", "doxygen", "Doxyfile"]), workdir= 'build', haltOnFailure = True))
|
||||
# Run sphinx apidoc
|
||||
factory.addStep(ShellCommand(command=' '.join([docActivateCmd(), "sphinx-apidoc","-T","-f","-o","apidoc","../CoolProp"]),workdir= 'build/Web', haltOnFailure = True))
|
||||
factory.addStep(ShellCommand(command=' '.join([docActivateCmd(), "sphinx-apidoc","-T","-f","-e","-o","apidoc","../wrappers/Python/CoolProp"]),workdir= 'build/Web', haltOnFailure = True))
|
||||
# Run sphinx website builder
|
||||
factory.addStep(ShellCommand(command=' '.join([docActivateCmd(), "make", "html"]), workdir= 'build/Web', haltOnFailure = True))
|
||||
# Upload the generated files
|
||||
|
||||
Reference in New Issue
Block a user