1057703 - treeherder-service readthedocs html build is failing

Status: RESOLVED FIXED

(Tree Management :: Treeherder, defect, P2)

Description

[Ed Morley [:emorley]]

Has been failing for several weeks:

https://readthedocs.org/builds/treeherder-service/

eg:
https://readthedocs.org/builds/treeherder-service/1624739/

Build Standard Error



html
-----

Sphinx v1.1.3
Usage: /home/docs/checkouts/readthedocs.org/user_builds/treeherder-service/envs/latest/bin/sphinx-build [options] sourcedir outdir [filenames...]
Options: -b <builder> -- builder to use; default is html
         -a        -- write all files; default is to only write new and changed files
         -E        -- don't use a saved environment, always read all files
         -t <tag>  -- include "only" blocks with <tag>
         -d <path> -- path for the cached environment and doctree files
                      (default: outdir/.doctrees)
         -c <path> -- path where configuration file (conf.py) is located
                      (default: same as sourcedir)
         -C        -- use no config file at all, only -D options
         -D <setting=value> -- override a setting in configuration
         -A <name=value>    -- pass a value into the templates, for HTML builder
         -n        -- nit-picky mode, warn about all missing references
         -N        -- do not do colored output
         -q        -- no output on stdout, just warnings on stderr
         -Q        -- no output at all, not even warnings
         -w <file> -- write warnings (and errors) to given file
         -W        -- turn warnings into errors
         -P        -- run Pdb on exception
Modi:
* without -a and without filenames, write new and changed files.
* with -a, write all files.
* with filenames, write these.


Environment Standard Error

...

install
-----

Traceback (most recent call last):
  File "setup.py", line 2, in <module>
    from Cython.Build import cythonize
ImportError: No module named Cython.Build

Comment 1

[Mauro Doglio [:mdoglio]]

Attachment: docs.txt

Comment 2

[Mauro Doglio [:mdoglio]]

There are 2 possible solutions to this:
1- add the docs requirements file in attachment to the repository and let rtd use it.
2- wrap the cython stuff in setup.py in a try/except clause

Comment 3

[Ed Morley [:emorley]]

Mauro landed:
https://github.com/mozilla/treeherder-service/commit/e1d1a62f3733ec7981cf0344b6ea967efa1e5844

With the RTD "use virtualenv" option checked (it wasn't just now), we're using that file and successfully generating the docs. We still get the Cython exception, however it doesn't affect the docs build (or the pass/fail shown on RTD), so let's ignore it for now. (Additional options would be to use Mock as suggested by http://read-the-docs.readthedocs.org/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules or else we could check for the presence of the READTHEDOCS env variable).