research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
6881 commits 2 branches 16 tags 37 MiB
Commit graph

412 commits

Author SHA1 Message Date
Bryan W. Weber
d143e8e1f0
[Doc] Fix documentation header to match main site 2018-09-30 20:19:57 -04:00
band-a-prend
72d2fc4f8c
[SCons/Doc] Fix too long time offline render of Sphinx Docs pages 
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.
 2018-09-29 23:21:50 +03:00
band-a-prend
59eabbe454
[SCons/Doc] Fix installation of Sphinx docs 
Fix installation of Cantera Sphinx Documentation
via similar way as it was done for Doxygen documentation
https://github.com/Cantera/cantera/commit/8f2468d
 2018-09-26 02:18:32 +03:00
Ray Speth
d6da006e3e [SCons] Only build the Python package for Python 3.x 2018-09-19 17:59:59 -04:00
Ray Speth
51263193de Bump version to 2.5.0a1 2018-08-28 16:45:49 -04:00
Ray Speth
8f2468da52 [SCons/Doc] Fix installation of Doxygen docs 
Fixes regression introduced in b84d3e3, where the organization of files in the built
documentation changed.

Fixes #553
 2018-08-24 09:24:45 -04:00
Ray Speth
f1d8d9b1b9 Bump version for 2.4.0 release 2018-08-20 18:52:09 -04:00
Ray Speth
e7a48375dc Bump version to 2.4.0b2 2018-08-10 22:51:18 -04:00
Ray Speth
a54ab2f3ef [Doc] Update docs related to StFlow restructuring 2018-08-10 18:15:36 -04:00
Ray Speth
ac8612f36b [Doc] Add IonFlow and related classes to Sphinx docs 2018-08-10 18:15:36 -04:00
Bryan W. Weber
045f3d37bf [Doc] Fix CSS font specification for Alabaster theme 
The font themes must be specified as a string rather than a list.
 2018-08-10 11:20:31 -04:00
Ray Speth
1864e8fd6c [Doc/CI] Fix Doxygen exclude pattern to not exclude all files on Travis 
On Travis, the build directory '/home/travis/build/cantera' matched the (no
longer needed) exclude pattern of ' /build/*', causing all source files to be
skipped.
 2018-07-30 19:40:24 -04:00
Bryan W. Weber
053267e254 [Doc] Generate XML output with Doxygen 
This output will be useful to generate links from the website pages to
the C++ documentation; see Cantera/cantera-website#16
 2018-07-29 17:47:14 -04:00
Bryan W. Weber
b84d3e3f79 [Doc] Enable generation of subdirectories to store the output 
The files kinetics.h and onedim.h are present as high-level application 
include files and as lower-level implementation include files. Doxygen 
generates HTML documentation for all files in the same folder, and on 
case-insensitive file systems, the documetation for the application and 
the implementation files will shadow each other. This commit enables the 
option to put documentation files into subfolders in the root directory, 
hopefully separating these "duplicate" files
 2018-07-29 17:47:14 -04:00
Bryan W. Weber
0d559778a7 [Doc] Update the Mathjax version for Doxygen 2018-07-29 17:47:14 -04:00
Bryan W. Weber
7e1b6a1489 [Doc/CI] Build the docs after testing and upload to cantera.org 
Use an ssh key with write access to cantera.org to rsync the built docs. Only
runs on non-pull-request builds of the master branch.

The sphinxcontrib-doxylink and sphinxcontrib-katex packages have bugs
that are fixed in our forks, so we have to install from the forks.
 2018-07-29 17:47:14 -04:00
Bryan W. Weber
549463683d Fix Sphinx and Doxygen warning messages about moved content 2018-07-29 17:47:14 -04:00
Bryan W. Weber
4ea9d35a2b Add the CTI API documentation back to the main index page 2018-07-29 17:47:14 -04:00
Bryan W. Weber
3fae1c1a9a Remove pages moved to the new website 2018-07-29 17:47:14 -04:00
Bryan W. Weber
9670c5dac6 Remove most content from Sphinx docs index page 
It's all moved elsewhere on the new site.
 2018-07-29 17:47:14 -04:00
Bryan W. Weber
dbc3df1687 Switch Sphinx docs to KaTeX instead of MathJax 2018-07-29 17:47:14 -04:00
Bryan W. Weber
e8d28b0e89 Redo layout.html to match the style of and to add links to the main site 
We need to replace most of the Sphinx-defaults with things that look
like our new Nikola website and that link to places in the Nikola
website.
 2018-07-29 17:47:14 -04:00
Bryan W. Weber
2a7aed8968 Switch to the alabaster theme for API documentation 2018-07-29 17:47:14 -04:00
Bryan W. Weber
3052701250 Remove Mathjax todo that has already been done 2018-07-29 17:47:14 -04:00
Bryan W. Weber
21db5d84f3 Move Matlab docs out of the code-docs subfolder 
Now that examples are gone, it's not needed anymore.
 2018-07-29 17:47:14 -04:00
Bryan W. Weber
b68a87d624 Make Matlab doc sections more consistent with Python sections 2018-07-29 17:47:14 -04:00
Bryan W. Weber
7a69386b8d Remove unused SConscript functions for building Python examples 2018-07-29 17:47:14 -04:00
Bryan W. Weber
e81cac9582 [Examples] Remove building Matlab examples into the docs 
They have moved to the new website
 2018-07-29 17:47:14 -04:00
Bryan W. Weber
cc9c8e5633 Remove "Migrating" docs 
It's been a few versions since we changed the Python module.
 2018-07-29 17:47:14 -04:00
Bryan W. Weber
7b6d04c381 [Examples] Remove building Python examples into the documentation 2018-07-29 17:47:14 -04:00
Ray Speth
b26dc65c41 [Doc] Provide links to docs for old versions of Cantera 2018-05-19 22:04:57 -04:00
Ray Speth
df6ecb101b [Doc] Fix notation for mixture-averaged diffusion coefficient 
Flame equations are formulated using Dkm *prime* (Eq. 12.180 from Kee et al),
not plain Dkm (Eq. 12.178).
 2018-05-19 22:04:57 -04:00
vishesh devgan
84acdb1a30 [Doc] hydrogen combustion example blank page removed 
Resolves #518
 2018-05-19 11:01:54 -04:00
Ray Speth
66ba4b5b50 [Doc] Add update of git submodules to code checkout instructions 2018-04-03 09:22:04 -04:00
Ray Speth
3d59914e6f Update version numbers for Cantera 2.4.0 
Includes pre-reserved DOI for Zenodo
 2018-02-17 16:05:44 -05:00
Ray Speth
d28032e845 Bump development version to 2.4.0b1 2018-02-15 23:59:59 -05:00
Bryan W. Weber
a0ac2b0cc6
[Doc] Update Doxygen MathJax link 
The MathJax CDN is shutting down
 2018-02-13 16:22:16 -05:00
Bryan W. Weber
66597b72ff
[Doc] Update about page with link to license 2018-02-10 11:53:25 -05:00
Bryan W. Weber
c29fbc808e
[Doc] Add Graphviz to optional documentation dependencies 2018-02-10 11:53:25 -05:00
Bryan W. Weber
1a394a3402
[Doc] Update compiling dependencies 
Especially Cython must be installed for Python where SCons is installed
 2018-02-10 11:53:25 -05:00
Bryan W. Weber
8195403fef
[Doc] DeCaluwe has a capital C 
We don't need any Belgian forebears haunting us
 2018-02-10 11:53:25 -05:00
Bryan W. Weber
05fa4df3b9
[Doc] Move citation information out of FAQ to About page 2018-02-10 11:53:24 -05:00
Bryan W. Weber
2abc57e2f1
[Doc] Add 'about' page to docs 
Includes info about NumFOCUS sponsorship and donation link, as well as
the steering committee
 2018-02-10 11:53:24 -05:00
Bryan W. Weber
c78a11b32f
[Doc] Add that projects can use C language to home page 2018-02-10 11:53:24 -05:00
Bryan W. Weber
0d20b50543
[Doc] Add Donation link to sidebar 2018-02-10 11:53:24 -05:00
Bryan W. Weber
977a1c7736
[Doc] Update Welcome text on homepage 2018-02-10 11:53:24 -05:00
Bryan W. Weber
8caf5e5aca
[Doc] Give the Python and Matlab example index pages more specific names 2018-02-10 11:53:23 -05:00
Bryan W. Weber
581cfb7c04
[Doc] Move Python migrating page to bottom of TOC 2018-02-10 11:53:23 -05:00
Bryan W. Weber
419a09c414
[Doc] Update install instructions in FAQ 2018-02-10 11:53:23 -05:00
Bryan W. Weber
ec5aecd3d6
[Doc] Update example links in FAQ 2018-02-10 11:53:23 -05:00