Speeding up ./mach build-docs ?

NEW
Unassigned

Status

()

Core
Build Config
3 years ago
3 years ago

People

(Reporter: Pike, Unassigned)

Tracking

Firefox Tracking Flags

(Not tracked)

Details

(Reporter)

Description

3 years ago
Getting a bug on file, for the lack of a good idea.

Is there a way to speed up ./mach build-docs?

I'm editing a doc, and the build time is 40+ secs to re-generate the single page I'm editing.

One thing that's apparently costly in time is SPHINX_PYTHON_PACKAGE_DIRS, I wonder if that something to switch off optionally?

Also, it'd be neat if one could just rebuild the part of the docs that one is currently editing, but I don't know if sphinx likes stunts like that.

Comment 1

3 years ago
Looking at this casually, the auto-generated rst files for the Python modules are always being written, even if they don't change. This causes mtimes to get bumped and for Sphinx to re-read them. Stopping this should yield some nice performance wins.
Component: mach → Build Config

Comment 2

3 years ago
So, I submitted changes to Sphinx for just this issue: https://bitbucket.org/birkenfeld/sphinx/pull-request/321/increase-performance-of-apidoc-processing/

I /thought/ that pull request had been merged. However, it hasn't.

It also appears the Sphinx project moved from Bitbucket to GitHub and didn't bother to say anything in the open pull request. Bah. I guess I'll re-submit the pull request on GitHub and hope for the best.
You need to log in before you can comment on or make changes to this bug.