Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Slow documentation builds #741

Open
dkfellows opened this issue Feb 27, 2025 · 2 comments
Open

Slow documentation builds #741

dkfellows opened this issue Feb 27, 2025 · 2 comments
Labels
documentation Improvements or additions to documentation maintenance Relating to general maintenance of the software

Comments

@dkfellows
Copy link
Collaborator

Is it just me or is the time to build the documentation with Sphinx very slow? Previous projects where I've used it have tended to be able to write tens of files per second, whereas hpcflow seems to slow to the point of taking a second or more for each output file (looking at things when they're building on Github). That's weird!

Dodgy hunch-based analysis

I'm not at all sure what's causing this (or why matflow isn't suffering) but I suspect it might be due to some sort of quadratic complexity behaviour triggered by the list of all versions of the documentation that gets embedded in each page. By now, hpcflow has a very large number of alpha versions...

@dkfellows dkfellows added documentation Improvements or additions to documentation maintenance Relating to general maintenance of the software labels Feb 27, 2025
@SJaffa
Copy link

SJaffa commented Feb 27, 2025

Just found a few other people suffering from slow builds that might contain useful info:

sphinx-doc/sphinx#4576
https://stackoverflow.com/questions/51986357/how-can-i-make-sphinx-build-build-faster

@dkfellows
Copy link
Collaborator Author

I've never delved deep into the guts of Sphinx, and the parts that I have seen have not encouraged me to change that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation maintenance Relating to general maintenance of the software
Projects
Status: 🔲 Todo
Development

No branches or pull requests

2 participants