Skip to content

Instantly share code, notes, and snippets.

@catermelon
Created July 18, 2013 17:04
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save catermelon/6031020 to your computer and use it in GitHub Desktop.
Save catermelon/6031020 to your computer and use it in GitHub Desktop.
Autodoc not worky
Running Sphinx v1.1.3+
building [html]: targets for 5 source files that are out of date
updating environment: 5 added, 0 changed, 0 removed
reading sources... [ 20%] attendee
reading sources... [ 40%] changelog
reading sources... [ 60%] contributing
reading sources... [ 80%] exchange2010calendarevent
Traceback (most recent call last):
File "/home/docs/checkouts/readthedocs.org/user_builds/pyexchange/envs/latest/local/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 321, in import_object
__import__(self.modname)
File "/home/docs/checkouts/readthedocs.org/user_builds/pyexchange/envs/latest/local/lib/python2.7/site-packages/pyexchange-0.3-py2.7.egg/pyexchange/__init__.py", line 8, in <module>
from .exchange2010 import Exchange2010Service # noqa
ImportError: No module named exchange2010
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 20%] attendee
writing output... [ 40%] changelog
writing output... [ 60%] contributing
writing output... [ 80%] exchange2010calendarevent
writing output... [100%] index
writing additional files... (0 module code pages) genindex py-modindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 9 warnings.
@davedash
Copy link

It can't find this module:
https://gist.github.com/trustrachel/6031020#file-autodoc-not-worky-L13

Can you stub it out? Maybe using sys.path hackery?

@davedash
Copy link

https://github.com/mozilla/zamboni/blob/master/docs/conf.py#L19-L20

For some simple stuff, I've done more crazy stuff before too.

@catermelon
Copy link
Author

I can't stub it out - it's part of the library. And the part I'm trying to autodoc.

I'll try the syspath hackery. Wish I could replicate it locally....

@catermelon
Copy link
Author

(thanks dave!)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment