gecko-dev/tools/docs
Andrew Halberstadt c52efbdc58 Bug 1410424 - [docs] Support live reloading with |mach doc| r=mshal
This changes the default to opening a livereload webserver after doc generation
(as opposed to opening the index file). Any changes to the specified path will
result in a rebuild and refresh of the browser.

For example, if you run:

    ./mach doc tools/lint

The linting docs will be built, served and opened in a browser. Modifying any
file under 'tools/lint/docs' will refresh the browser with your changes.

To disable this behaviour and simply open the index file, you can pass in
'--no-serve'. The '--no-open' flag will continue to work (both with http and
the file system).

One caveat to this patch is that when generating the root docs (by running
|mach doc|), we don't watch all possible doc paths (just the root one under
'tools/docs/'). This will probably be fixed in the follow-up bug 1454640.

MozReview-Commit-ID: FQecuePM0zZ

--HG--
extra : rebase_source : 3240402d7505e99a4f64dada309b1baec78306e1
2018-04-06 10:52:56 -04:00
..
moztreedocs Bug 1438839 - autopep8 -i --max-line-length 99 on the tools/ r=ahal 2018-03-15 11:32:42 +01: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
mach_commands.py Bug 1410424 - [docs] Support live reloading with |mach doc| r=mshal 2018-04-06 10:52:56 -04:00
requirements.txt Bug 1410424 - [docs] Support live reloading with |mach doc| r=mshal 2018-04-06 10:52:56 -04:00