658103 - Configure Sphinx documentations to be integrated with the codebase

Status: RESOLVED FIXED

(addons.mozilla.org Graveyard :: Add-on Builder, defect, P3)

Description

[Piotr Zalewa [:zalun]]

Currently Sphinx fails on my development box with a 

 log = commonware.log.getLogger('f.jetpack.managers')
 AttributeError: 'module' object has no attribute 'log'

Which probably means it uses a commonware module version without log attribute.
This makes the docText not working in majority of modules.

Comment 1

[Wil Clouser [:clouserw]]

Does this summary match the comment 0?  This seems like two different bugs

Comment 2

[Piotr Zalewa [:zalun]]

Sphinx has a conf.py where there is a need to specify all dependencies.
I did my best, but I'm receiving above error.

Comment 3

[Daniel Buchner [:dbuc]]

Piotr, we are not using Sphinx on the Builder, I adjusted the title to account for this. Is this related to Elastic Search?

Comment 4

[Dave Dash [:davedash, :dd] (assign all bugs to mbrandt)]

Not sphinx search, sphinx docs.

Comment 5

[Dave Dash [:davedash, :dd] (assign all bugs to mbrandt)]

This is blocked by rtfd: https://github.com/rtfd/readthedocs.org/issues/77

Comment 6

[Piotr Zalewa [:zalun]]

@dave. it is blocked on read the docs, but I'm unable to produce valid docs with the code locally as well, which could be fixed.

Comment 7

[Dave Dash [:davedash, :dd] (assign all bugs to mbrandt)]

Cool, also a work-around has been published in issues/77.

Comment 8

[Piotr Zalewa [:zalun]]

In review
Possibly needs more modules to be excluded (mocked) from build on readthedocs
https://github.com/zalun/FlightDeck/commit/ab9acd63d3f870235ac6783a0877af8b7dad970b

Comment 9

[Piotr Zalewa [:zalun]]

OK - I've now succesfully Mocked MySQLdb (at least for our project)!
https://github.com/mozilla/FlightDeck/commit/464c53b755d0eecb72967205023c84065c5ad26f

It shows as in here: 
http://flightdeck.readthedocs.org/en/latest/repackage/implementation.html