Skip to content

Commit

Permalink
Add docs for Cantera 2.0-2.5
Browse files Browse the repository at this point in the history
  • Loading branch information
speth committed Mar 27, 2022
0 parents commit 7290ce8
Show file tree
Hide file tree
Showing 18,239 changed files with 5,714,353 additions and 0 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
34 changes: 34 additions & 0 deletions add_warning.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
"""Add warning to old docs."""

import lxml.html as lh
from lxml import etree
from pathlib import Path

bquote = etree.Element("blockquote")
d = etree.SubElement(bquote, "div")
admonition = etree.SubElement(d, "div", {"class": "admonition warning"})
head = etree.SubElement(admonition, "p", {"class": "first admonition-title"})
head.text = "Warning"
last = etree.SubElement(admonition, "p", {"class": "last"})
last.text = "This documentation is for an old version of Cantera. You can find docs for newer versions "
link = etree.SubElement(
last,
"a",
{"class": "reference external", "href": "https://cantera.org/documentation"},
)
link.text = "here"
link.tail = "."

folders = [Path(f"api-docs/docs-{x}") for x in (2.4,)]
for folder in folders:
for html_file in folder.glob("sphinx/**/*.html"):
print(html_file)

doc = lh.parse(str(html_file))
body = doc.xpath('//div[@class="body"]')[0]
body.insert(0, bquote)

head = doc.find("head")
meta = etree.SubElement(head, "meta", {"name": "robots", "content": "noindex"})
with open(html_file, "w", encoding="utf-8") as file_obj:
file_obj.write(lh.tostring(doc).decode("utf-8"))
41 changes: 41 additions & 0 deletions bump_katex.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import lxml.html as lh
from pathlib import Path

for f in Path("api-docs/docs-2.4/sphinx/html").glob("**/*.html"):
print(f)
doc = lh.parse(str(f))
head = doc.find("head")
for l in head.findall("link"):
if "jsdelivr" not in l.get("href", ""):
continue
l.set("href", "https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css")
l.set(
"integrity",
"sha384-zB1R0rpPzHqg7Kpt0Aljp8JPLqbXI3bhnPWROx27a9N0Ll6ZP/+DiW/UqRcLbRjq",
)
l.set("crossorigin", "anonymous")

for l in head.findall("script"):
if "jsdelivr" not in l.get("src", ""):
continue
if "katex.min.js" in l.get("src"):
l.set("src", "https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.js")
l.set(
"integrity",
"sha384-y23I5Q6l+B6vatafAwxRu/0oK/79VlbSz7Q9aiSZUvyWYIYsd+qj+o24G5ZU2zJz",
)
elif "auto-render.min.js" in l.get("src"):
l.set(
"src",
"https://cdn.jsdelivr.net/npm/[email protected]/dist/contrib/auto-render.min.js",
)
l.set(
"integrity",
"sha384-kWPLUVMOks5AQFrykwIup5lo0m3iMkkHrD0uJ4H5cjeGihAutqP0yW0J6dpFiVkI",
)

l.set("defer", None)
l.set("crossorigin", "anonymous")

with open(f, "w") as file_obj:
file_obj.write(lh.tostring(doc).decode("utf-8"))
4 changes: 4 additions & 0 deletions dev/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Ignore everything in this directory
*
# Except this file
!.gitignore
107 changes: 107 additions & 0 deletions docs-2.0/doxygen/html/AdsorbateThermo_8h.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Cantera: AdsorbateThermo.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Cantera
&#160;<span id="projectnumber">2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<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>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> </div>
<div class="headertitle">
<div class="title">AdsorbateThermo.h File Reference</div> </div>
</div><!--header-->
<div class="contents">

<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.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="SpeciesThermoInterpType_8h_source.html">SpeciesThermoInterpType.h</a>&quot;</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for AdsorbateThermo.h:</div>
<div class="dyncontent">
<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>
</div>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<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>
</div>
</div>
</div>
<p><a href="AdsorbateThermo_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<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>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<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>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<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>

<p>Definition in file <a class="el" href="AdsorbateThermo_8h_source.html">AdsorbateThermo.h</a>.</p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</small></address>
</body>
</html>
42 changes: 42 additions & 0 deletions docs-2.0/doxygen/html/AdsorbateThermo_8h__dep__incl.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
88 changes: 88 additions & 0 deletions docs-2.0/doxygen/html/AdsorbateThermo_8h__incl.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 7290ce8

Please sign in to comment.