Skip to content

Commit

Permalink
Address review comments for docs
Browse files Browse the repository at this point in the history
Co-authored-by: Ray Speth <[email protected]>
  • Loading branch information
bryanwweber and speth committed Jul 29, 2024
1 parent 82e077b commit a1ee588
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 23 deletions.
3 changes: 1 addition & 2 deletions doc/sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,6 @@
'sphinx_copybutton',
]



sphinx_gallery_conf = {
'filename_pattern': r'\.py',
'example_extensions': {'.py', '.cpp', '.h', '.c', '.f', '.f90', '.m'},
Expand Down Expand Up @@ -213,6 +211,7 @@ def escape_splats(app, what, name, obj, options, lines):
'pint': ('https://pint.readthedocs.io/en/stable/', None),
}

myst_heading_anchors = 2
myst_enable_extensions = [
"dollarmath",
"amsmath",
Expand Down
4 changes: 2 additions & 2 deletions doc/sphinx/develop/distribution-packages/pypi-sdist-wheel.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ testing.
a. `scons clean sdist` can also be used to automatically remove the
`build` folder prior to building the `sdist.
1. Building the wheel requires that Boost and libhdf5 are available on the build system.
If these are not installed in standard locations, you can set `Boost_ROOT` and
If these are not installed in standard locations, you can set `BOOST_ROOT` and
`HDF5_ROOT` environment variables to point to the correct location.
1. Change to the `build/python_sdist/dist` folder
1. Unpack the sdist: `tar xf cantera-3.1.0a2.tar.gz`. Note the version `3.1.0a2` may be
Expand Down Expand Up @@ -141,7 +141,7 @@ Steps 3 and 4 are set up in the `interfaces/python_sdist/cantera/CMakeLists.txt`

When a version of Cantera is ready to be published to PyPI, the workflow in the
[pypi-packages](https://github.com/Cantera/pypi-packages) repository must be executed.
The workflow essentially conducts the steps in the [TLDR](#tldr) section above.
The workflow essentially conducts the steps in the [](#tldr) section above.

The one big addition to the GitHub Action workflow is that there are a couple of shell
scripts in the `pypi-packages` repository to build libhdf5 for macOS and Windows. On
Expand Down
38 changes: 19 additions & 19 deletions doc/sphinx/develop/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,25 +29,6 @@ compiling/config-options
compiling/special-cases
```

(sec-distributing)=
## Distributing Built Cantera Packages

- [](distribution-packages/pypi-sdist-wheel)
- [](distribution-packages/conda)
- [](distribution-packages/ubuntu-ppa)
- [](distribution-packages/windows-and-macos.md)

```{toctree}
:caption: Distributing Built Cantera Packages
:hidden:
:maxdepth: 1
distribution-packages/pypi-sdist-wheel
distribution-packages/conda
distribution-packages/ubuntu-ppa
distribution-packages/windows-and-macos
```

## How Cantera Works

```{caution}
Expand Down Expand Up @@ -86,3 +67,22 @@ running-tests
writing-examples
doc-formatting
```

(sec-distributing)=
## Distributing Built Cantera Packages

- [](distribution-packages/pypi-sdist-wheel)
- [](distribution-packages/conda)
- [](distribution-packages/ubuntu-ppa)
- [](distribution-packages/windows-and-macos.md)

```{toctree}
:caption: Distributing Built Cantera Packages
:hidden:
:maxdepth: 1
distribution-packages/pypi-sdist-wheel
distribution-packages/conda
distribution-packages/ubuntu-ppa
distribution-packages/windows-and-macos
```

0 comments on commit a1ee588

Please sign in to comment.