gecko-dev/tools/docs
Andrew Halberstadt fe81229ade Bug 1454640 - [docs] Always build docs with the tools/docs/conf.py r=mshal
Previously, running |mach doc <subtree>| would use whatever conf.py file
happened to live in the subtree. For example, running:

./mach doc tools/lint

Would build with tools/lint/docs/conf.py. This is bad because it means the
generated docs will look different from the docs that eventually will be
published to firefox-source-docs.mozilla.com.

This patch makes sure we always use tools/docs/conf.py for building, even when
only generating a subtree.

Furthermore, this sets things up such that when you modify a file, only the
subtree containing the modified file will be re-generated.  This cuts down
rebuild times from ~2 minutes to ~20 seconds.

There is one caveat. When rebuilding a subtree, the index of other trees will
be overwritten in that particular subtree. I couldn't figure out anyway around
this. This tradeoff for *much* faster rebuild times seems worth it.

MozReview-Commit-ID: Ly88mvHKpo7

--HG--
extra : source : 47fc3e2238676a40a3adc84239baed1ce873e95e
2018-04-18 17:18:11 -04:00
..
moztreedocs Bug 1454640 - [docs] Memoize the result of processing sphinx moz.build variables r=mshal 2018-04-18 15:01:10 -04:00
conf.py Bug 1372406: Follow-up: Add missing source directory to docs config. r=bustage 2018-03-28 12:23:15 -07:00
index.rst
jsdoc.json Bug 1423425 Let sphinx-js read .js files r=erik 2017-12-05 18:53:59 -08:00
mach_commands.py Bug 1454640 - [docs] Always build docs with the tools/docs/conf.py r=mshal 2018-04-18 17:18:11 -04:00
requirements.txt Backed out 11 changesets (bug 1437593) for Doc linting failure. CLOSED TREE 2018-04-28 12:02:02 +03:00