Open nolash opened 2 months ago
Thanks for your Ansible docs contribution! We talk about Ansible documentation on matrix at #docs:ansible.im and on libera IRC at #ansible-docs if you ever want to join us and chat about the docs! We meet there on Tuesdays (see the Ansible calendar) and welcome additions to our weekly agenda items - scroll down to find the upcoming agenda and add a comment to put something new on that agenda.
Hi @nolash ! So you are correct, building the full Ansible package documentation is a major resource hog. It basically communicates to Ansible Galaxy for every collection in the package.
Can you explain what your trying to do? If for example, you want to make a docs change and test that locally, you could try make coredocs
instead. Also, for every PR, the CI here will build a test docsite for you, so you could use that option as well.
Yeah, sphinx is a memory hog, especially when parallelization is enabled and the size/complexity of our docs that @samccann mentioned. You can try exporting CPUS=1
— or another number that's lower than the default in the Makefile, i.e., the total number of threads your CPU has — before calling nox to reduce the amount of memory used. nox -e make
defaults to building the minimal coredocs, but even these can use a fair amount of resources to build.
I build devel
d4e77888a45cde3745e7edd7ad9039fffef8ea2b
with commandnox
(I wanted to buildv2.17.3
but if failed due to missing parameters in a file, probably deps version issue).It took 8 whole minutes to build on:
It also gobbled up all my available ram - 5gb - while building, nearly grinding my device to a halt.
Seems a bit unreasonable just to build some docs...
python 3.12.5
nox==2024.4.15
I've uploaded the built html files here, in case someone else want to browse them offline:
https://g33k.holbrook.no/8425e9f019d31f5696334c5694c084e7de27d0050698fd3f2607839e78c84146