Ray Speth
d3569efd1f
[Doc] Ensure Cython .py changes cause Sphinx doc rebuilds
2026-07-10 15:08:48 -04:00
Ray Speth
1a94634d1e
[SCons] Trigger API doc rebuilds after changes to Cython files
2026-06-10 10:31:50 -04:00
Ray Speth
5427add944
Remove legacy Clib
2025-11-21 21:38:21 -05:00
Ray Speth
1dab14bbfb
[SCons] Install docs based on prior doc build
...
Also eliminate extra 'html' subdirectory in install destination
2025-11-13 20:59:39 -06:00
Ray Speth
b596173094
Remove "_experimental" suffix from Matlab toolbox path
2025-11-09 21:39:10 -05:00
Ingmar Schoegl
485b5eb983
[doc] Make C# samples available
2025-11-03 12:15:03 -05:00
Ingmar Schoegl
36bd072033
[clib] Remove 'generated' from CLib tests
2025-09-22 21:06:38 -04:00
Ingmar Schoegl
7d85643ace
[clib] Drop 'generated' from CLib samples
2025-09-22 21:06:38 -04:00
Ingmar Schoegl
cd6dab30ac
[SCons] Avoid temporary CLib folder names
2025-06-04 13:24:20 -05:00
Ingmar Schoegl
be39ece92e
[SCons] Update CLib nomenclature
...
Rename clib_experimental->clib_generated and clib->clib_legacy.
2025-06-04 13:24:20 -05:00
Ingmar Schoegl
51c014cb7b
[SCons/docs] Final cleanup
2025-06-04 13:24:20 -05:00
Ingmar Schoegl
b45c0a933f
[sourcegen/doc] Use single tag file
2025-06-04 13:24:20 -05:00
Ingmar Schoegl
8354469916
[clib] Shorten interfaces/clib path
2025-06-04 13:24:20 -05:00
Ingmar Schoegl
d6d5880443
[SCons/sourcegen] Implement SConscript for clib
2025-06-04 13:24:20 -05:00
Ingmar Schoegl
80e8a6afd3
[docs] Add experimental CLib demo to docs
2025-05-25 06:21:22 -05:00
Ingmar Schoegl
18b6a67e7c
[SCons] Replace from buildutils import *
2024-09-28 16:41:43 -05:00
Ingmar Schoegl
3f7d0ff726
[SCons] Remove unused imports
2024-09-15 12:30:18 -05:00
Ray Speth
6e170b3187
[Doc] Make Sphinx search work when hosting docs locally
...
The javascript for the search box wouldn't work due to an earlier
error in the javascript for the version switcher when the switcher
JSON file couldn't be loaded.
2024-06-25 17:42:07 -04:00
Ray Speth
98b8fa63cc
[SCons] Add option to skip running Sphinx Gallery examples
2024-06-03 23:26:46 -04:00
Ray Speth
fca36a5906
[Doc] Show CONTRIBUTING.md contents on website
2024-06-02 17:23:59 -04:00
Ingmar Schoegl
0303dba060
[MATLAB-legacy] Remove MATLAB from doc build
2024-03-28 09:27:10 -04:00
Ray Speth
a7021138a1
Migrate compilation docs into Sphinx/MyST
2023-10-09 16:40:37 -04:00
Ray Speth
c96e470e61
Add Python tutorial as a MyST notebook
...
Adds dependency on myst-nb, which is currently pinned to Sphinx<6
2023-10-09 16:40:37 -04:00
Ray Speth
c533ca90bb
[Doc] Flatten output directory structure
...
Copy Doxygen output into a subdirectory of Sphinx so the Sphinx
index can be the full site index.
Partially addresses Cantera/cantera-website#229
2023-10-09 16:40:37 -04:00
Ray Speth
553d5def17
[SCons] Use logging option to adjust Sphinx logging
2023-10-03 11:23:39 -04:00
Ray Speth
faadf015ee
Add Matlab examples to sphinx-gallery
2023-10-03 11:23:39 -04:00
Ray Speth
6eb4f08907
Add clib example to sphinx-gallery
2023-10-03 11:23:39 -04:00
Ray Speth
732e7e89fa
Add Fortran examples to sphinx-gallery
2023-10-03 11:23:39 -04:00
Ray Speth
f720a573db
[Doc] Add C++ examples to sphinx-gallery
2023-10-03 11:23:39 -04:00
Ray Speth
6c0b9b80fc
[Doc] Build Sphinx docs and run gallery samples in build dir
...
Sphinx-gallery creates new .rst files alongside existing manually
maintained documentation, and runs the samples in-place, generating
their output files in the source tree. Moving this all to the build
directory lets us keep the repo clean.
2023-10-03 11:23:39 -04:00
Ray Speth
5e50be34f3
[Doc] Fix building Sphinx docs on macOS
...
macOS doesn't allow passing DYLD_LIBRARY_PATH through a shell, so
we need to use subprocess.call to be able to call sphinx-build while
including build/lib in the library path. The need to have the library
path set for this is a result of the transition to linking the Python
module against a shared version of libcantera.
2023-03-13 22:58:24 -05:00
Ray Speth
1c5595e16c
[SCons] Consolidate addition of build/lib to search path
2023-02-02 18:33:16 -06:00
Ray Speth
8114f2f828
[SCons] Link Python module to Cantera shared library
2023-02-02 18:33:16 -06:00
Ingmar Schoegl and Bryan Weber
8f509fb176
[SCons] Adopt review feedback
...
Co-authored-by: Bryan Weber <bryan.w.weber@gmail.com >
2022-06-12 19:54:01 -04:00
Ingmar Schoegl
e68c7de040
[SCons] Add custom FAILED logging level
2022-06-12 19:54:01 -04:00
Ray Speth
2bd70c8e59
Remove CTI/XML from C++
2022-05-25 04:02:58 -04:00
Ray Speth
7d9551dd74
Remove XML/CTI format from Matlab toolbox
2022-05-25 04:02:58 -04:00
Bryan Weber
27696feab8
Rename mglob function to multi_glob
2021-05-04 21:36:21 -04:00
Bryan Weber
edf5e4cc77
Limit exported functions from buildutils
...
Each SConscript module imports what it needs from the stdlib.
2021-05-04 21:36:21 -04:00
Raymond Speth
daf7d4d575
Remove deprecated code marked for removal after Cantera 2.5
2021-02-16 14:00:57 -05:00
Bryan W. Weber
44ed2642ca
[SCons] Add configuration for Sphinx options
...
The default will exit the Sphinx build with error code 1 if any warnings
are encountered, but it will print all the warnings from a single run.
Since all the warnings from Sphinx are now resolved, this change means
that any CI failures due to warnings from Sphinx should be fixed before
merging a pull request.
2021-02-12 16:57:15 -05:00
Bryan W. Weber
daa36668e7
[SCons] Fix Sphinx docs build in parallel
...
The Sphinx build requires both the Cython module to have been built and
the doxygen run to have finished. When running the build in parallel
with scons build -j#, there was the possibility that Sphinx could run
before all its dependencies were built. This change adds dependencies
for the Sphinx builder on Doxygen and the Cython module, resolving the
problem.
2021-02-12 16:57:15 -05:00
Bryan W. Weber
a35344d74f
[SCons] Avoid shadowing built-in str type
2021-02-12 16:57:15 -05:00
Ray Speth
6f45b241b5
Remove code deprecated in Cantera 2.4
2018-12-14 11:27:24 -05: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
8f2468da52
[SCons/Doc] Fix installation of Doxygen docs
...
Fixes regression introduced in b84d3e3Fixes #553
2018-08-24 09:24:45 -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
Ray Speth
Ingmar Schoegl
band-a-prend