Skip to content

"scons install" doesn't install doxygen/sphinx documentation #2032

@band-a-prend

Description

@band-a-prend

Problem description
When build cantera with doxygen_docs=yes option or/and optionally with scons sphinx after cantera build (sphinx_docs option build is broken, see #1871) and then run scons install command the html documentation isn't installed under share/cantera/doc directory: there is only LICENSE.txt file while scons install reports that

*************** Cantera 3.2.0b1 has been successfully installed ****************
File locations:
...
HTML documentation          <my_prefix>/share/cantera/doc`
...

This issue is "related" to #553 but it's not duplicate and could be related to changes introduced in c533ca9.

Steps to reproduce

  1. Set scons "doxygen_docs" configuration option to "y"
  2. Build Cantera (scons build) and notice that doxygen documentation subdirectories are presented in appropriate build subfolder (i.e. ./build/doc/html)
  3. Run "scons install" and check the <my_prefix>/share/cantera/doc/doxygen/html/ folder under installation path. Notice that it contains only LICENSE.txt file.

I used for this example the following build command:

scons -j4 build AR=x86_64-pc-linux-gnu-ar CC=x86_64-pc-linux-gnu-gcc CXX=x86_64-pc-linux-gnu-g++ cc_flags="-march=native -O2 -pipe" cxx_flags=-std=c++20 debug=no renamed_shared_libraries=no use_pch=no doxygen_docs=yes system_fmt=y system_sundials=y system_eigen=y system_yamlcpp=y hdf_support=y system_blas_lapack=n env_vars=all extra_inc_dirs=/usr/include/eigen3 use_rpath_linkage=yes extra_lib_dirs=/usr/lib64/cantera system_highfive=y googletest=none f90_interface=n python_package=y python_cmd=python3.12 python_prefix="~/projects/cantera_install/lib/python3.12" prefix="~/projects/cantera_install"

P.S.
The python_prefix="~/projects/cantera_install/lib/python3.12" was set to optionally run scons sphinx to build sphinx documentation. Even with this option there are errors about absence of python cantera module but at least the sphinx documentation is built under ./build/doc/html but without examples pictures.
P.S. 2
When I build scons sphinx within Gentoo package build environment there is no problem with build examples pictures (except huge amount of time to run examples to generate results) and there are no errors about cantera python module. So I assume the P.S. is just related the absence of setup the locel python env paths.

Behavior

System information

  • Cantera version: 3.2.0b1
  • OS: Gentoo Linux
  • Python/MATLAB/other software versions:
    Python 3.12.11
    SCons 4.10.0

Attachments

Additional context

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions