Freeseer / freeseer

Designed for capturing presentations at conferences. Pre-fill a list of talks to record, record them, and upload them to YouTube with our YouTube Uploader.
http://freeseer.readthedocs.org
GNU General Public License v3.0
215 stars 110 forks source link

Building documents with `make html` has many errors. #592

Closed SRomansky closed 9 years ago

SRomansky commented 9 years ago

The following is ouput after running make html in terminal from freeseer/doc :

ImportError: No module named plugins.videoinput.videotestsrc
~/freeseer/docs/source/userguide/config/plugins/video-mixer.rst:4: WARNING: autodoc: failed to import module u'freeseer.plugins.videomixer.videopassthrough'; the following exception was raised:
Traceback (most recent call last):
  File "/usr/local/lib/python2.7/dist-packages/sphinx/ext/autodoc.py", line 335, in import_object
    __import__(self.modname)
ImportError: No module named plugins.videomixer.videopassthrough
~/freeseer/docs/source/userguide/config/plugins/video-mixer.rst:5: WARNING: autodoc: failed to import module u'freeseer.plugins.videomixer.pip'; the following exception was raised:
Traceback (most recent call last):
  File "/usr/local/lib/python2.7/dist-packages/sphinx/ext/autodoc.py", line 335, in import_object
    __import__(self.modname)
ImportError: No module named plugins.videomixer.pip
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] userguide/config/plugins/video-mixer                   
writing additional files... (0 module code pages) genindex search
copying static files... WARNING: html_static_path entry u'~/freeseer/docs/source/_static' does not exist
done
copying extra files... done
dumping search index... done
dumping object inventory... done
build succeeded, 20 warnings.

In terminal: pip list | grep Sphix outputs Sphinx (1.2.3).

mtomwing commented 9 years ago

I'm guessing this is because freeseer is not in your PYTHONPATH (that's where Python looks for modules). Try adding PYTHONPATH="$PYTHONPATH:/path/to/your/repo/src" to see if that's the case.

SRomansky commented 9 years ago

That resolved 10 of the warnings.

building [html]: targets for 33 source files that are out of date
updating environment: 33 added, 0 changed, 0 removed
reading sources... [100%] userguide/youtube-uploader                            
~/freeseer/docs/source/contribute/basics.rst:None: WARNING: nonlocal image URI found: https://docs.google.com/drawings/d/1hPslTdzT7SLZsudFGOIS9M5o6G1Q3HcY4-q0F8BNKWQ/pub?w=737&h=619
~/freeseer/docs/source/contribute/students.rst:2: WARNING: Duplicate explicit target name: "project proposal document".
~/freeseer/docs/source/release-engineering.rst:8: WARNING: Enumerated list ends without a blank line; unexpected unindent.
~/freeseer/docs/source/release-engineering.rst:9: WARNING: Block quote ends without a blank line; unexpected unindent.
~/freeseer/docs/source/release-engineering.rst:15: WARNING: Enumerated list ends without a blank line; unexpected unindent.
~/freeseer/docs/source/release-engineering.rst:17: WARNING: Block quote ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] userguide/youtube-uploader                             
~/freeseer/docs/source/about/index.rst:31: WARNING: unknown document: /contribute/documentation
~/freeseer/docs/source/contribute/basics.rst:142: WARNING: unknown document: developers/pull-requests-and-code-review
~/freeseer/src/freeseer/plugins/output/rtmp_streaming/__init__.py:docstring of freeseer.plugins.output.rtmp_streaming:10: WARNING: undefined label: config (if the link has no caption the label must precede a section header)
writing additional files... (0 module code pages) genindex py-modindex search
copying images... [100%] images/record-prepare.png                              
copying static files... WARNING: html_static_path entry u'~/freeseer/docs/source/_static' does not exist
done
copying extra files... done
dumping search index... done
dumping object inventory... done
build succeeded, 10 warnings.

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

Is the new output, but this I can debug.