Commit Graph

7 Commits

Author SHA1 Message Date
Gregory Szorc
6802f0c912 Bug 1115278 - Add virtualenv to Sphinx environment; r=glandium
Python API documentation requires the ability to import modules. So, we
set up a virtualenv in our Sphinx environment so module loading works.

This solution isn't perfect: a number of modules fail to import when run
under sphinx-build.
2014-12-24 10:17:02 -08:00
Gregory Szorc
b4eda56fb0 Bug 1115278 - Move Sphinx documentation staging into Sphinx extension; r=glandium
Previously, code for staging the Sphinx documentation from moz.build
metadata lived in a mach command and in the moztreedocs module. This
patch moves the invocation to the Sphinx extension.

When the code is part of the Sphinx extension, it will run when executed
with sphinx-build. This is a prerequisite to getting RTD working, since
sphinx-build is the only supported entrypoint for generating
documentation there.

With this patch, we can now invoke sphinx-build to build the
documentation. The `mach build-docs` command is no longer needed.
2014-12-24 09:46:41 -08:00
Gregory Szorc
7737017be8 Bug 1091722 - Use Read The Docs theme for Sphinx; r=glandium
Read the Docs has a lovely Sphinx theme that beats the pants off the
built-in and default theme. And since it looks like MDN's Sphinx theme
is dead in the water, this gets us a nice UI win until the MDN theme
comes back from the dead.
2014-10-30 10:09:29 -07:00
Gregory Szorc
b0e61ecbd0 Bug 1040416 - Remove javasphinx extension from Sphinx config; r=nalexander
The extension was added by accident in bug 1033686.

DONTBUILD (NPOTB)
2014-07-23 09:22:48 -07:00
Eric Edens
d41886d0ba Bug 1033686 - Make sure pre-search and post-search replace each other. r=nalexander 2014-07-11 11:42:37 -07:00
Gregory Szorc
01fdbeb787 Bug 987332 - Disable MDN theme until it works; r=nalexander
The MDN theme is currently busted. This patch reverts to the default
Sphinx theme so we have docs that are more usable.

DONTBUILD (NPOTB)
2014-06-16 14:53:49 -07:00
Gregory Szorc
71001b1f06 Bug 939367 - Allow Sphinx docs to come from all over the tree; r=glandium 2013-11-20 12:37:22 -08:00