1213959 - Unbust Sphinx docs generation due to mach shell detection error

Status: RESOLVED FIXED

(Firefox Build System :: General, defect)

Description

[Gregory Szorc [:gps]]

+++ This bug was initially created as a clone of Bug #1212427 +++

We're still busted on RTD:

Running Sphinx v1.3.1
making output directory...

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/gecko/envs/latest/local/lib/python2.7/site-packages/sphinx/cmdline.py", line 244, in main
    opts.warningiserror, opts.tags, opts.verbosity, opts.jobs)
  File "/home/docs/checkouts/readthedocs.org/user_builds/gecko/envs/latest/local/lib/python2.7/site-packages/sphinx/application.py", line 143, in __init__
    self.setup_extension(extension)
  File "/home/docs/checkouts/readthedocs.org/user_builds/gecko/envs/latest/local/lib/python2.7/site-packages/sphinx/application.py", line 440, in setup_extension
    ext_meta = mod.setup(self)
  File "/home/docs/checkouts/readthedocs.org/user_builds/gecko/checkouts/latest/python/mozbuild/mozbuild/sphinx.py", line 180, in setup
    from moztreedocs import SphinxManager
  File "/home/docs/checkouts/readthedocs.org/user_builds/gecko/checkouts/latest/tools/docs/moztreedocs/__init__.py", line 9, in <module>
    from mozbuild.frontend.reader import BuildReader
  File "/home/docs/checkouts/readthedocs.org/user_builds/gecko/checkouts/latest/python/mozbuild/mozbuild/frontend/reader.py", line 43, in <module>
    from mozbuild.testing import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/gecko/checkouts/latest/python/mozbuild/mozbuild/testing.py", line 12, in <module>
    from .base import MozbuildObject
  File "/home/docs/checkouts/readthedocs.org/user_builds/gecko/checkouts/latest/python/mozbuild/mozbuild/base.py", line 17, in <module>
    from mach.mixin.process import ProcessExecutionMixin
  File "/home/docs/checkouts/readthedocs.org/user_builds/gecko/checkouts/latest/python/mach/mach/mixin/process.py", line 29, in <module>
    raise Exception('Could not detect environment shell!')
Exception: Could not detect environment shell!

Exception occurred:
  File "/home/docs/checkouts/readthedocs.org/user_builds/gecko/checkouts/latest/python/mach/mach/mixin/process.py", line 29, in <module>
    raise Exception('Could not detect environment shell!')
Exception: Could not detect environment shell!

Comment 2

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1213959 - Set SHELL in Read the Docs environment; r?ted

Bug 1213959 - Set SHELL in Read the Docs environment; r?ted

The Read the Docs environment doesn't have SHELL defined. This causes
mach.mixin.process's import to fail, as it insists on finding an active
shell. While we could fix mach.mixin.process to not raise if the
variable is not set, this is a bit more work and has wider build system
and mach implications. So we employ a quick hack instead.

DONTBUILD (NPOTB)

Comment 3

[(not currently active) Ted Mielczarek]

Comment on attachment 8683112 [details]
MozReview Request: Bug 1213959 - Set SHELL in Read the Docs environment; r?ted

https://reviewboard.mozilla.org/r/24191/#review21671

Comment 4

[Gregory Szorc [:gps]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/b68d229e03c5f5297616e5716adc6b68b29bf665
Bug 1213959 - Set SHELL in Read the Docs environment; r=ted

Comment 5

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/b68d229e03c5

Comment 6

[Gregory Szorc [:gps]]

https://gecko.readthedocs.org/en/latest/ is working again \o/