The Sphinx build requires both the Cython module to have been built and
the doxygen run to have finished. When running the build in parallel
with scons build -j#, there was the possibility that Sphinx could run
before all its dependencies were built. This change adds dependencies
for the Sphinx builder on Doxygen and the Cython module, resolving the
problem.
This has been bugging me for years, and I'm very happy to have finally
fixed it! To debug this, I used the -vv output from sphinx-build to
inspect what autodoc was doing. autodoc seemed to have no problem
reading the source, but it was indeed generating reST with unmatched
emphasis and strong markers. Although it really seems like autodoc
should be able to handle this case, apparently it can't. Then, I was
reading the autodoc documentation when I noticed this idea of an event
handler, a function that gets called whenever a particular event
happens. I realized I could get in and munge the docstring text to
replace any unescaped splats with escaped ones.
The KaTeX version is no longer configurable in the sphinxcontrib-katex
extension. There is now a Python script in the website repository
api-docs folder that can bump the KaTeX version in the built
documentation to match the version supplied by sphinxcontrib-katex.
This model can easily be replaced with StoichSustance using ConstCpPoly for the
species thermo.
The changed values in the LiSi regression tests suggest that there are some
implementation errors in the FixedChemPotSSTP class which will be automatically
resolved by eliminating it.
Ensure that the name returned by Sub::name() is a name that can be used to
reconstruct a substance of the same type.
Make phase names in liquidvapor.yaml match the substance model names.
Add parsing of arguments passed when the script is run from the command
line. A new function is introduced to parse the arguments and is the
default function when the file is executed as a script. Update the
documentation to add the new function.
Add a new argument to convert that takes a string containing the content
of a CTML file. This allows convert to be used from within the Python
interpreter more easily.
The water-IAPWS95 instantiates either WaterSSTP or PDSS_water objects,
both of which are intended for liquid phases only. Clarify the phase
name to liquid-water-IAPWS95 to allow a future phase that could
represent the full liquid<->vapor phase space.
Add asynchronous ('async', 'media' and conditional 'defer' attributes) loading of remote javascript
and css files within Cantera 2.4.0 Sphinx Documentation to avoid too long render of pages
in case of offline usage of documentation.
Bryan W. Weber
Raymond Speth
Ingmar Schoegl
Ingmar Schoegl
band-a-prend