Skip to content

Commit

Permalink
[Doc] Use 'python' instead of 'cython' for filenames and refs
Browse files Browse the repository at this point in the history
Partially addresses Cantera/cantera-website#229
  • Loading branch information
speth committed Oct 6, 2023
1 parent fb8ebb9 commit 676ef26
Show file tree
Hide file tree
Showing 17 changed files with 6 additions and 7 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _sec-cython-documentation:
.. _sec-python-documentation:

Python Module Documentation
===========================
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. py:currentmodule:: cantera
.. _sec-cython-onedim:
.. _sec-python-onedim:

One-dimensional Reacting Flows
==============================
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. py:currentmodule:: cantera
.. _sec-cython-zerodim:
.. _sec-python-zerodim:

Zero-Dimensional Reactor Networks
=================================
Expand Down
4 changes: 2 additions & 2 deletions doc/sphinx/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ mechanism files.
```
```{grid-item-card} Python API Reference
:link: cython/index
:link: python/index
:link-type: doc
:text-align: center
```
Expand All @@ -43,7 +43,7 @@ mechanism files.
:caption: API Reference
yaml/index
cython/index
python/index
matlab/index
```

Expand Down
3 changes: 1 addition & 2 deletions include/cantera/extensions/PythonExtensionManager.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ namespace Cantera
//!
//! Imports a user-specified module, which must be on the Python path and registers
//! user-defined classes that are marked with the `@extension` decorator. See the
//! documentation for
//! <a href="../../sphinx/html/cython/utilities.html#cantera.extension">`@extension`</a>
//! documentation for [\@extension](../python/utilities.html#cantera.extension)
//! in the Python documentation for more information.
//!
//! @since New in %Cantera 3.0
Expand Down

0 comments on commit 676ef26

Please sign in to comment.