Skip to content

Commit 66a3ce0

Browse files
author
y-p
committed
Merge pull request #6193 from y-p/PR_contrib_fast_doc
DOC: contributing.rst, document fast doc building
2 parents 0c938e6 + 40fe754 commit 66a3ce0

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

doc/README.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,16 @@ If you want to do a full clean build, do::
133133
python make.py build
134134

135135

136+
Staring with 0.13.1 you can tell ``make.py`` to compile only a single section
137+
of the docs, greatly reducing the turn-around time for checking your changes.
138+
139+
python make.py --no-api # omit autosummary and api section
140+
python make.py --single indexing # compile the docs with only a single
141+
# section, that which is in indexing.rst
142+
143+
For comparision, a full doc build may take 10 minutes. a ``-no-api`` build
144+
may take 3 minutes and a single section may take 15 seconds.
145+
136146
Where to start?
137147
---------------
138148

0 commit comments

Comments
 (0)