835976 - Upgrade Sphinx

Status: VERIFIED FIXED

(Participation Infrastructure :: Phonebook, defect)

Description

[Justin Crawford [:hoosteeno] [:jcrawford]]

Running "make html" blows up (locally) with the current version of Sphinx. Updating Sphinx (to 1.1.3 for me) fixes it. This is also the version being used by RTFD (see the footer), which I think explains why the bug hasn't impacted live docs.

tl;dr command line replays below, in case they are helpful.


(venv)docs$ sphinx-build -? 2>&1 | head -1
Sphinx v1.1

(venv)docs$ make html
sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v1.1
loading pickled environment... not yet created
building [html]: targets for 6 source files that are out of date
updating environment: 6 added, 0 changed, 0 removed
reading sources... [ 16%] index                                                                                                                                                   
Exception occurred:
  File "/Users/Justin/Documents/mozilla/projects/mozillians/venv/lib/python2.7/site-packages/sphinx/util/nodes.py", line 183, in set_role_source_info
    inliner.reporter.locator(lineno)
AttributeError: Reporter instance has no attribute 'locator'
The full traceback has been saved in /var/folders/5x/252pjrs941df058q_czr5lsh0000gn/T/sphinx-err-dSqBEi.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
Either send bugs to the mailing list at <http://groups.google.com/group/sphinx-dev/>,
or report them in the tracker at <http://bitbucket.org/birkenfeld/sphinx/issues/>. Thanks!
make: *** [html] Error 1

(venv)docs$ pip install sphinx --upgrade
<snip>

(venv)docs$ sphinx-build -? 2>&1 | head -1
Sphinx v1.1.3

(venv)docs$ make html
sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v1.1.3
loading pickled environment... not yet created
building [html]: targets for 6 source files that are out of date
updating environment: 6 added, 0 changed, 0 removed
reading sources... [100%] testing                                                                                                                                                 
/Users/Justin/Documents/mozilla/projects/mozillians/docs/installation-vagrant.rst:74: WARNING: Literal block expected; none found.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] testing                                                                                                                                                  
writing additional files... genindex search
copying static files... WARNING: html_static_path entry '/Users/Justin/Documents/mozilla/projects/mozillians/docs/_static' does not exist
done
dumping search index... done
dumping object inventory... done
build succeeded, 2 warnings.

Build finished. The HTML pages are in _build/html.

Comment 1

[Justin Crawford [:hoosteeno] [:jcrawford]]

PR here: https://github.com/mozilla/mozillians/pull/619

Comment 2

[[github robot]]

Commits pushed to master at https://github.com/mozilla/mozillians

https://github.com/mozilla/mozillians/commit/b2a1034aaaedb5bdce6466928630963f07165075
[fix bug 835976] Upgrade sphinx

https://github.com/mozilla/mozillians/commit/d21e892622c9c62e824fa7402ab32f8060cf4921
Merge pull request #619 from hoosteeno/sphinx

[fix bug 835976] Upgrade sphinx

Comment 3

[Matt Brandt [:mbrandt]]

Bumping to verified as [qa-]