Ed Morley
331a39bff2
Bug 1421241 - Docs: Add livehtml to the Makefile help text
2017-11-28 16:56:45 +00:00
Ed Morley
86e1402369
Bug 1421241 - Docs: Improve error shown when Sphinx not installed
2017-11-28 16:56:45 +00:00
Ed Morley
194e3e3be5
Bug 1421241 - Docs: Improve livehtml mode and recommend it
...
* Removes the unnecessary initial `make html`, since sphinx-autobuild
performs the initial build itself.
* Enables `--poll` watch mode, since file change detection otherwise
doesn't work in Vagrant.
* Updates the docs to recommend the livereload web server over the
one-off build when working on docs locally.
2017-11-28 16:56:45 +00:00
Ed Morley
607007d7e8
Bug 1421241 - Docs: Reduce nesting of build output directory
...
Since there is only ever one build type, so the nested directory is
unnecessary and makes it more annoying to find the built assets.
2017-11-28 16:56:45 +00:00
Ed Morley
b7e6db1f94
Bug 1421241 - Docs: Remove unused Makefile targets
...
We don't use any of the other build modes:
http://www.sphinx-doc.org/en/stable/builders.html#builders
2017-11-28 16:56:45 +00:00
Ed Morley
7bca4d8e97
Bug 1420891 - Docs: Enable strict & 'nit-picky' mode when building
...
So that the build fails if there are any warnings:
http://www.sphinx-doc.org/en/stable/invocation.html#invocation-of-sphinx-build
2017-11-28 16:56:45 +00:00
William Lachance
7cfc022a5b
Add autobuild target for docs makefile
...
Based on work by Armen Zambrano <armenzg@mozilla.com>
2016-05-31 15:34:26 -04:00
Ed Morley
94c0d9aeb7
Bug 1058600 - Update sphinx build using output from newer sphinx-quickstart; r=mdoglio
2014-08-26 14:57:39 +01:00
mdoglio
fe1c449459
add sphinx docs setup
2013-03-12 13:17:52 +00:00