Skip to content

Commit 7290ce8

Browse files
spethspeth
committed
Add docs for Cantera 2.0-2.5
0 parents  commit 7290ce8

File tree

18,239 files changed

+5714353
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

18,239 files changed

+5714353
-0
lines changed

‎add_warning.py

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
"""Add warning to old docs."""
2+
3+
import lxml.html as lh
4+
from lxml import etree
5+
from pathlib import Path
6+
7+
bquote = etree.Element("blockquote")
8+
d = etree.SubElement(bquote, "div")
9+
admonition = etree.SubElement(d, "div", {"class": "admonition warning"})
10+
head = etree.SubElement(admonition, "p", {"class": "first admonition-title"})
11+
head.text = "Warning"
12+
last = etree.SubElement(admonition, "p", {"class": "last"})
13+
last.text = "This documentation is for an old version of Cantera. You can find docs for newer versions "
14+
link = etree.SubElement(
15+
last,
16+
"a",
17+
{"class": "reference external", "href": "https://cantera.org/documentation"},
18+
)
19+
link.text = "here"
20+
link.tail = "."
21+
22+
folders = [Path(f"api-docs/docs-{x}") for x in (2.4,)]
23+
for folder in folders:
24+
for html_file in folder.glob("sphinx/**/*.html"):
25+
print(html_file)
26+
27+
doc = lh.parse(str(html_file))
28+
body = doc.xpath('//div[@class="body"]')[0]
29+
body.insert(0, bquote)
30+
31+
head = doc.find("head")
32+
meta = etree.SubElement(head, "meta", {"name": "robots", "content": "noindex"})
33+
with open(html_file, "w", encoding="utf-8") as file_obj:
34+
file_obj.write(lh.tostring(doc).decode("utf-8"))

‎bump_katex.py

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
import lxml.html as lh
2+
from pathlib import Path
3+
4+
for f in Path("api-docs/docs-2.4/sphinx/html").glob("**/*.html"):
5+
print(f)
6+
doc = lh.parse(str(f))
7+
head = doc.find("head")
8+
for l in head.findall("link"):
9+
if "jsdelivr" not in l.get("href", ""):
10+
continue
11+
l.set("href", "https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css")
12+
l.set(
13+
"integrity",
14+
"sha384-zB1R0rpPzHqg7Kpt0Aljp8JPLqbXI3bhnPWROx27a9N0Ll6ZP/+DiW/UqRcLbRjq",
15+
)
16+
l.set("crossorigin", "anonymous")
17+
18+
for l in head.findall("script"):
19+
if "jsdelivr" not in l.get("src", ""):
20+
continue
21+
if "katex.min.js" in l.get("src"):
22+
l.set("src", "https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.js")
23+
l.set(
24+
"integrity",
25+
"sha384-y23I5Q6l+B6vatafAwxRu/0oK/79VlbSz7Q9aiSZUvyWYIYsd+qj+o24G5ZU2zJz",
26+
)
27+
elif "auto-render.min.js" in l.get("src"):
28+
l.set(
29+
"src",
30+
"https://cdn.jsdelivr.net/npm/[email protected]/dist/contrib/auto-render.min.js",
31+
)
32+
l.set(
33+
"integrity",
34+
"sha384-kWPLUVMOks5AQFrykwIup5lo0m3iMkkHrD0uJ4H5cjeGihAutqP0yW0J6dpFiVkI",
35+
)
36+
37+
l.set("defer", None)
38+
l.set("crossorigin", "anonymous")
39+
40+
with open(f, "w") as file_obj:
41+
file_obj.write(lh.tostring(doc).decode("utf-8"))

‎dev/.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Ignore everything in this directory
2+
*
3+
# Except this file
4+
!.gitignore

‎docs-2.0/doxygen/html/AdsorbateThermo_8h.html

+107
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<title>Cantera: AdsorbateThermo.h File Reference</title>
7+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
8+
<script type="text/javascript" src="jquery.js"></script>
9+
<script type="text/javascript" src="dynsections.js"></script>
10+
<script type="text/x-mathjax-config">
11+
MathJax.Hub.Config({
12+
extensions: ["tex2jax.js"],
13+
jax: ["input/TeX","output/HTML-CSS"],
14+
});
15+
</script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
16+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
17+
</head>
18+
<body>
19+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
20+
<div id="titlearea">
21+
<table cellspacing="0" cellpadding="0">
22+
<tbody>
23+
<tr style="height: 56px;">
24+
<td style="padding-left: 0.5em;">
25+
<div id="projectname">Cantera
26+
&#160;<span id="projectnumber">2.0</span>
27+
</div>
28+
</td>
29+
</tr>
30+
</tbody>
31+
</table>
32+
</div>
33+
<!-- end header part -->
34+
<!-- Generated by Doxygen 1.8.2 -->
35+
<div id="navrow1" class="tabs">
36+
<ul class="tablist">
37+
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
38+
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
39+
<li><a href="modules.html"><span>Modules</span></a></li>
40+
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
41+
<li><a href="annotated.html"><span>Classes</span></a></li>
42+
<li class="current"><a href="files.html"><span>Files</span></a></li>
43+
</ul>
44+
</div>
45+
<div id="navrow2" class="tabs2">
46+
<ul class="tablist">
47+
<li><a href="files.html"><span>File&#160;List</span></a></li>
48+
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
49+
</ul>
50+
</div>
51+
<div id="nav-path" class="navpath">
52+
<ul>
53+
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_6fbe91f1050ba110875dc8b0702a61ee.html">cantera</a></li><li class="navelem"><a class="el" href="dir_3cc50e07c07b6e5dfebd896073e0298f.html">thermo</a></li> </ul>
54+
</div>
55+
</div><!-- top -->
56+
<div class="header">
57+
<div class="summary">
58+
<a href="#nested-classes">Classes</a> &#124;
59+
<a href="#namespaces">Namespaces</a> </div>
60+
<div class="headertitle">
61+
<div class="title">AdsorbateThermo.h File Reference</div> </div>
62+
</div><!--header-->
63+
<div class="contents">
64+
65+
<p>Header for a single-species standard state object derived from <a class="el" href="classCantera_1_1SpeciesThermoInterpType.html">SpeciesThermoInterpType</a> based on the expressions for the thermo properties of a species with several vibrational models.
66+
<a href="#details">More...</a></p>
67+
<div class="textblock"><code>#include &quot;<a class="el" href="SpeciesThermoInterpType_8h_source.html">SpeciesThermoInterpType.h</a>&quot;</code><br/>
68+
</div><div class="textblock"><div class="dynheader">
69+
Include dependency graph for AdsorbateThermo.h:</div>
70+
<div class="dyncontent">
71+
<div class="center"><iframe scrolling="no" frameborder="0" src="AdsorbateThermo_8h__incl.svg" width="379" height="336"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
72+
</div>
73+
</div>
74+
</div><div class="textblock"><div class="dynheader">
75+
This graph shows which files directly or indirectly include this file:</div>
76+
<div class="dyncontent">
77+
<div class="center"><iframe scrolling="no" frameborder="0" src="AdsorbateThermo_8h__dep__incl.svg" width="415" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
78+
</div>
79+
</div>
80+
</div>
81+
<p><a href="AdsorbateThermo_8h_source.html">Go to the source code of this file.</a></p>
82+
<table class="memberdecls">
83+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
84+
Classes</h2></td></tr>
85+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCantera_1_1Adsorbate.html">Adsorbate</a></td></tr>
86+
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An adsorbed surface species. <a href="classCantera_1_1Adsorbate.html#details">More...</a><br/></td></tr>
87+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
88+
</table><table class="memberdecls">
89+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
90+
Namespaces</h2></td></tr>
91+
<tr class="memitem:namespaceCantera"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCantera.html">Cantera</a></td></tr>
92+
<tr class="memdesc:namespaceCantera"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides class <a class="el" href="classCantera_1_1Nucleus.html" title="Represents atomic nuclei.">Nucleus</a>. <br/></td></tr>
93+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
94+
</table>
95+
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
96+
<div class="textblock"><p>Header for a single-species standard state object derived from <a class="el" href="classCantera_1_1SpeciesThermoInterpType.html">SpeciesThermoInterpType</a> based on the expressions for the thermo properties of a species with several vibrational models. </p>
97+
98+
<p>Definition in file <a class="el" href="AdsorbateThermo_8h_source.html">AdsorbateThermo.h</a>.</p>
99+
</div></div><!-- contents -->
100+
<!-- start footer part -->
101+
<hr class="footer"/><address class="footer"><small>
102+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
103+
<img class="footer" src="doxygen.png" alt="doxygen"/>
104+
</a> 1.8.2
105+
</small></address>
106+
</body>
107+
</html>

‎docs-2.0/doxygen/html/AdsorbateThermo_8h__dep__incl.svg

+42
Loading

‎docs-2.0/doxygen/html/AdsorbateThermo_8h__incl.svg

+88
Loading

0 commit comments

Comments
 (0)