Read the Docs build times out while compiling ABACUS to generate parameter documentation #8171

Description

The abacus-rtd Read the Docs build for PR #8093 timed out before reaching Sphinx.

• Commit: 0a91abde60fed9a383dfb3b12f74d343ff854d81
• Failed build: https://app.readthedocs.org/projects/abacus-rtd/builds/35218892/
• Reported duration: 903 seconds
• RTD notification: “Build terminated due to time out.”

Where it stopped

CMake configuration succeeded with MPI and LCAO disabled:

cmake -Bbuild -GNinja -DCMAKE_INSTALL_PREFIX=install -DENABLE_MPI=OFF -DENABLE_LCAO=OFF

The build was terminated during:

cmake --build build --target install -j $(nproc)

The available log contains no C++ compilation error. Parameter export and Sphinx had not started. The separate abacus-develop RTD check succeeded for the same commit, so the failure is not consistent across the two RTD projects.

Why documentation builds compile ABACUS

The current .readthedocs.yaml builds and installs ABACUS to generate the INPUT parameter documentation from the current code:

install/bin/abacus --generate-parameters-yaml > docs/parameters.yaml
python3 docs/generate_input_main.py docs/parameters.yaml

This makes documentation checks depend on a full executable build fitting within RTD's resource limits. ABACUS will support more abilities and the compiling time will be longer and longer.

Proposed next step

A lightweight parameter-export target, or generating the parameter documentation in GitHub Actions before rendering it on RTD.