prithviulm / qudi-core

A framework for modular measurement applications.
https://qudi-core-testing.readthedocs.io/en/latest/
GNU General Public License v3.0
0 stars 2 forks source link

The docs take hilariously long to build [Bug] #6

Closed prithviulm closed 2 weeks ago

prithviulm commented 6 months ago

Version

Development

What is affected by the bug?

Potentilally timing-out on RTD. The limit is 15min and 25ee70467fa1b02ded8b31698deb1f34a5416c11 already takes 7mins and it's not even with all the documentation and fancy formatting and examples and whatever else. The problem is likely with recursing into submodules as well as the cross-linking of modules/ classes/ functions across the entire documentation.

When does the bug occur?

When building the docs.

How do we replicate the issue?

Build the docs on rtd.

Expected behavior

Do not time out.

Relevant log output

No response

Additional Comments

The Makefile currently allows Sphinx to run the build in parallel utilising all cores so build times are acceptable when run locally but I don't think RTD supports using multiple cores. I'm not even sure how to specify multiple cores because RTD does not use the Makefile but their own custom command to build the docs with Sphinx. See their build overview for more info.

Contact Details

No response

prithviulm commented 2 weeks ago

Not an issue anymore.