diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py index 976f01afb4..473b8e622d 100644 --- a/doc/sphinx/conf.py +++ b/doc/sphinx/conf.py @@ -48,8 +48,6 @@ 'sphinx_copybutton', ] - - sphinx_gallery_conf = { 'filename_pattern': r'\.py', 'example_extensions': {'.py', '.cpp', '.h', '.c', '.f', '.f90', '.m'}, @@ -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", diff --git a/doc/sphinx/develop/distribution-packages/pypi-sdist-wheel.md b/doc/sphinx/develop/distribution-packages/pypi-sdist-wheel.md index 6a41f64b4c..a159718330 100644 --- a/doc/sphinx/develop/distribution-packages/pypi-sdist-wheel.md +++ b/doc/sphinx/develop/distribution-packages/pypi-sdist-wheel.md @@ -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 @@ -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 diff --git a/doc/sphinx/develop/index.md b/doc/sphinx/develop/index.md index 0857c40571..864430be13 100644 --- a/doc/sphinx/develop/index.md +++ b/doc/sphinx/develop/index.md @@ -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} @@ -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 +```