dhhagan / py-opc

Python wrapper for the Alphasense OPC-N2 built around py-spidev
MIT License
30 stars 26 forks source link

python-sphinx required to build html docs #68

Closed tshu closed 6 years ago

tshu commented 6 years ago

When navigating to py-opc/docs and running 'make html', I experience the following issues in order:

For reference, I have a clean install of Raspbian 9 (stretch) on kernel version 4.14.34-v7+ using a Pi 3 B+.

  1. python-sphinx dependency not found

Makefile:12: *** The 'sphinx-build' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the 'sphinx-build' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/. Stop.

Resolved with $ pip install - U sphinx

  1. dependency on sphinx package sphinx_rd_theme

Exception occurred: File "conf.py", line 17, in <module> import sphinx_rtd_theme ImportError: No module named sphinx_rtd_theme

Resolved with $ pip install sphinx_rtd_theme

  1. dependency on sphinx package mock

`ImportError: No module named mock

Makefile:55: recipe for target 'html' failed make: *** [html] Error 2`

Resolved with $ pip install mock

Can the associated documentation be updated to reflect these steps? Or perhaps there's an easier way you know of that can be mentioned before building the documentation.