GreenPolyProducts/cantera
5
0
Fork 0
mirror of https://github.com/Cantera/cantera.git synced 2026-08-19 01:14:44 -05:00
Code Issues Packages Projects Releases Wiki Activity
7,829 Commits 14 Branches 46 Tags
aae64d9b7beb9964e3ec1b499ceb8f98a26f7f5e
Commit Graph
44 Commits
Author SHA1 Message Date
Bryan W. Weber 4ff4b78d5e [Sphinx] Fix spurious warnings in __init__ docs 
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.
 2021-02-12 16:57:15 -05:00
Bryan W. Weber 4947fa6a4f [Doc] Fix NumPy intersphinx location 
Use pathlib to read configuration file for Cantera's current version.
This avoids leaving the file handle open.
 2021-02-12 16:57:15 -05:00
Raymond Speth 4f265d11a7 [Doc] Fix missing Python class member documentation 
Sphinx 1.8 deprecated the 'autodoc_default_flags' option. It appears
to have stopped working without warning in more recent versions.
 2021-02-09 22:18:20 -05:00
Ingmar Schoegl 9b53599d01 Happy New Year! 2021-01-18 17:02:15 -05:00
Bryan W. Weber 28baede600 [Doc] KaTeX version is no longer configurable 
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.
 2020-06-26 18:00:38 -04:00
Ingmar Schoegl 028a054c60 Happy New Year! 2020-01-03 17:09:28 -05:00
Bryan W. Weber 1d62ec0439 [Doc] Add documentation for ctml2yaml script 
Add intersphinx extension to auto-link to Python docs. Bump KaTeX
version.
 2019-12-01 21:07:44 -05:00
Ray Speth d6da006e3e [SCons] Only build the Python package for Python 3.x 2018-09-19 17:59:59 -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
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 3052701250 Remove Mathjax todo that has already been done 2018-07-29 17:47:14 -04:00
Bryan W. Weber 0d20b50543 [Doc] Add Donation link to sidebar 2018-02-10 11:53:24 -05:00
Bryan W. Weber e6b4761c6b Happy New Year! 2018-02-10 11:53:22 -05:00
Bryan W. Weber e846505f57 [Doc] Use Sphinx Mathjax extension 2018-02-08 16:41:08 -05:00
Ray Speth 6546c08f29 Bump version and copyright year for 2.3.0 release 2017-01-12 14:00:35 -05:00
Ray Speth 5fbe2303ca [Python] Fix test suite to work with Python 3.2 
The u'foo' syntax which can be used in Python 2.7 and 3.3+ does not work with
Python 3.2.
 2016-06-24 17:15:14 -04:00
Bryan W. Weber 848650f4fb [Doc] Fix copyright year 2016-02-06 07:44:09 -05:00
Ray Speth 6994d56587 [Doc] Sphinx reads version info from config.h 2015-06-14 20:00:54 -04:00
Ray Speth 430c59634a [Doc] Extend sphinxdoc theme instead of overwriting CSS file 
Overwriting the CSS file caused styles to fall out-of-date with the HTML
generated by newer versions of Sphinx. This way, we just need to maintain a few
customizations to the base theme.
 2015-06-12 18:34:44 -04:00
Ray Speth 416490ad7a Bump version to 2.2.0 2015-06-04 18:41:20 -04:00
Ray Speth 772427014a Bump version to 2.2.0b1 2015-05-11 17:23:37 -04:00
Ray Speth a3ec8c0848 [Doc] Use https for MathJax CDN 
This is needed to make MathJax work when loading the documentation over an https
URL, since some browsers block scripts from non-https sites when loading a page
over https.
 2015-05-07 11:29:22 -04:00
Ray Speth 18e2ab7c8d [Python/Doc] Document Reaction and derived classes 2015-05-05 11:34:07 -04:00
Bryan W. Weber f4041d6fb2 [Doc] Add the ability to pseudo-autodocument MATLAB code to the SConscript file 2014-07-18 14:32:53 +00:00
Ray Speth b5e540c903 [Python] Remove the legacy Python module 2013-12-09 01:35:08 +00:00
Ray Speth 6b68564245 Bump trunk version to 2.2a 2013-12-09 01:33:58 +00:00
Ray Speth 957c88fcff Bump version to 2.1.0 2013-10-24 02:40:14 +00:00
Ray Speth 7683677cac Bump version to 2.1.0b3 2013-09-01 00:33:55 +00:00
Ray Speth 4d88fa8e34 Bump version to 2.1.0b2 2013-08-02 23:31:36 +00:00
Ray Speth e65cd38214 Bump version to 2.1.0b1 2013-07-23 15:53:31 +00:00
Ray Speth ab7775e67e [Cython] Fix Python 2.6 compatibility issues with sys.version_info 
The "major" attribute is a new feature in Python 2.7.
 2013-07-18 22:39:26 +00:00
Ray Speth 5a722f9608 Added docstrings to Cython ThermoPhase class 2012-09-06 19:58:50 +00:00
Ray Speth 0c904bebfa Added infrastructure for using Sphinx to document the new Python module 
This includes adding the sphinx_cmd option to SCons, which can be set to the
Python 3 version of sphinx-build as necessary.
 2012-09-06 19:58:13 +00:00
Ray Speth 5bb6edb133 Bump version number of development version (trunk) 2012-07-10 16:25:39 +00:00
Ray Speth f3c3f47bc5 Incremented version number (2.0.0b3) 2012-06-05 19:56:26 +00:00
Ray Speth 095f43c1eb Added modified CSS for Sphinx documentation 
This CSS (from Matplotlib) adds thick lines before each documented
class and thin lines at the start of each documented method.
 2012-04-04 18:46:16 +00:00
Ray Speth 3938a6bfa7 Moved Matlab input tutorial into Sphinx documentation 2012-04-04 18:46:11 +00:00
Ray Speth e6a5abdfae Added header logo to documentation 2012-04-04 18:45:31 +00:00
Ray Speth 3acf30b3aa Moved build directories for docs to make relative links consistent 2012-04-04 18:45:26 +00:00
Ray Speth c44ef99775 Added doxylink Sphinx extension for creating links to Doxygen docs 2012-03-30 23:46:48 +00:00
Ray Speth d573ae6625 Configured Sphinx to use MathJax 2.0 2012-03-15 19:51:09 +00:00
Ray Speth b4ceb7da2e Reformatted the Python docstrings to work better with Sphinx 
This means that the docstrings are now parsed as reStructuredText.
 2012-03-13 17:34:47 +00:00
Ray Speth 09d9ded2e7 Added templates for using Sphinx to generate the Python module docs 2012-03-13 17:34:38 +00:00