michaelh/zephyr
1
0
Fork 0
Code Releases Activity

Revert "doc: enable figures enumeration" cause numfig is too slow

Browse source 
This reverts commit 4516117e9f.

A git bisect showed that the duration of an incremental build doubled
after this commit enabled `numfig=True`. Measurements shared and
discussed in #37572, #55708 and #56631 confirmed this. Here are yet more
measurements below in two different system configurations building docs
for very recent Zephyr commit b10817ba25 + all `:numref:` removed by
the previous commit. In other words these numbers show the cost of
`numfig=True` _without_ even using `:numref:`.

* Ubuntu 22, 8 cores
  sphinx-build --version 4.3.2

                           numfig=True   numfig=False

- from scratch             7 min 15 s       6 min 40 s

- one-line .rst change           48 s             24s

* Current Arch Linux, 72 cores
  sphinx-build --version 6.2.1

                           numfig=True   numfig=False

- from scratch              5 min 0 s      4 min 50 s

- one-line .rst change           37 s            18 s

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
This commit is contained in:
Marc Herbert 2023-05-05 21:59:09 +00:00 • committed by Carles Cufí
commit 9d11943194
1 changed files with 0 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/conf.py
View file

@ -103,8 +103,6 @@ pygments_style = "sphinx"
todo_include_todos = False todo_include_todos = False
numfig = True
nitpick_ignore = [ nitpick_ignore = [
# ignore C standard identifiers (they are not defined in Zephyr docs) # ignore C standard identifiers (they are not defined in Zephyr docs)
("c:identifier", "FILE"), ("c:identifier", "FILE"),