Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(docs): parallelize generation of dot graphs
Building the Sunshine docs is currently agonizingly slow because it generates many hundreds of dot graphs in serial, without any parallelization. This commits sets `DOT_NUM_THREADS` to 0, which causes `doxygen` to determine on its own a reasonable level of parallelization, based on the number of processors available on the system. The speed difference with this change is incredibly dramatic. I haven't performed particularly rigorous testing, but on my fairly weak laptop building the docs after applying this patch takes about 35 seconds. Without applying this patch, building the docs instead takes a ridiculous 135 seconds. This is on an M1 machine with only 4 performance cores and 4 efficiency cores. On a more powerful machine, the difference will be even more marked. Unless there's some reason I'm not aware of why the doc files need to be created in serial, I recommend enabling parallelization so that it isn't so painful to build the documentation. See also: https://xkcd.com/303
- Loading branch information