Offline Cantera Documentation

[Weiqi Ji]

Hi All,

Is there any way to get an offline Cantera documentation, such as .pdf file? Or someone can help generate one from the website.

BTW, personally speaking, I like the old fashion of Cantera online document in which the contents are categorized.

Best.

Weiqi

[Nick Curtis]

Hi Weiqi,

I know you can build a local copy of the doxygen docs (i.e., for the C++ classes) via the command-line via 'scons doxygen'.

I believe a copy of the documentation website can be created via 'scons sphinx'.

Nick

[Bryan W. Weber]

Weiqi,

As Nick said you can build a local copy of the HTML version of the API documentation (that is, the documentation of all the functions in Cantera) using Sphinx and Doxygen. When you build Cantera, you can follow Nick's suggestion, or use

scons build sphinx_docs=y doxygen_docs=y

to build both at once. The dependencies required to build the docs are on the website. 

If you then want a PDF copy of the docs, you can build that as well. Once the library is built, change to the doc directory and use the sphinx-build command (installed with Sphinx) to build LaTeX sources, which can be compiled using pdflatex

scons build ...
cd doc/
sphinx-build -b latex . _build
cd _build
make

should make a PDF of the API docs.

If you have specific suggestions for how to improve the new website, please feel free to share, either here or you can email me directly! I'm not sure what you found better about the old website, and I would be very interested to hear what you think; personally, I found it impossible to read and figure out where I wanted to go, and I hope the new site is an improvement in that regard. The API documentation is still split out by category, so we tried to maintain that portion at least.

Thanks,

Bryan

[Weiqi Ji]

Thank you Bryan and Nick.Briyan , could you help build a PDF version and share it here? I have never compiled the Cantera my self.

[Bryan W. Weber]

Weiqi,

I've attached a PDF of the v2.4.0 documentation

Bryan