-
Notifications
You must be signed in to change notification settings - Fork 0
Archived building Python docs with Sphinx
Dominic Ford edited this page Dec 19, 2018
·
3 revisions
I've set up Sphinx to build docs for the modules in src/pythonModules. To make it run you'll need to get Sphinx itself along with the theme I've used. This must be done from a virtualenv where the Pi Gazing modules are installed in at least develop mode, so from a clean system:
> virtualenv env
> source ./env/bin/activate
> cd src/pythonModules/meteorpi_model
> python setup.py develop
> cd ../meteorpi_fdb
> python setup.py develop
> cd ../meteorpi_server
> python setup.py develop
> cd ../meteorpi_client
> python setup.py develop
> pip install sphinx
> pip install sphinx_rtd_theme
> cd ../docs
> make clean html
You should end up with a website with all the API docs in _build/html
Pi Gazing overview
Building your own Pi Gazing camera
Camera software setup
Structure of the Pi Gazing software
Future directions