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

Add sphinx dependency to dev-requirements #575

Closed FranciscoCanas closed 9 years ago

FranciscoCanas commented 9 years ago

The section on installing Freeseer for development in the quick-start document (http://freeseer.readthedocs.org/en/latest/quick-start.html) is missing sphinx and python-sphinx for all except the Fedora requirements.

Since the documentation build is part of the test suite, all Freeseer developers should have sphinx installed.

dideler commented 9 years ago

I didn't explain the issue properly, my bad.

Sphinx is intentionally missing from the commands in the Quick Start guide because the dependency is in a requirements.txt file for pip. The problem is that it's in /docs/requirements.txt, while it should be in /requirements.txt since we're now building the docs as part of the test suite.

dideler commented 9 years ago

It's worth noting that one of the students had trouble installing Sphinx using pip, and had to use easy_install. I think this was on Windows. Should investigate the best way to install Sphinx.