search

nasa-jpl-memex / memex-explorer

Viewers for statistics and dashboarding of Domain Search Engine data
BSD 2-Clause "Simplified" License
121 stars 69 forks source link

Update README to Include Documentation Build #491

Closed lewismc closed 9 years ago

lewismc commented 9 years ago

This is a real easy one we discussed on the telecon earlier today. I'll send a simple PR for adding guidance on building the documentation.

lewismc commented 9 years ago

Actually, I can't build the docs

lmcgibbn@LMC-032857 /usr/local/memex-explorer/docs(master) $ sphinx-build -b html source/ build/
Running Sphinx v1.2.2

Exception occurred:
  File "conf.py", line 17, in <module>
ImportError: No module named sphinx_rtd_theme
The full traceback has been saved in /var/folders/xd/mmrnt3jd3hj2k52cb01cqys8001klv/T/sphinx-err-A7PpWx.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://bitbucket.org/birkenfeld/sphinx/issues/>. Thanks!

This is after running

$ pip install sphinx_rtd_theme

Any ideas please folks?

ahmadia commented 9 years ago

@lewismc - sphinx_rtd_theme should be installed in the conda environment for memex-explorer. My process might look something like:

git clone https://github.com/memex-explorer/memex-explorer
cd memex-explorer
conda env create
source activate memex

You need to do that last line every time you'd like to load the conda environment.

brittainhard commented 9 years ago

Been done for a while now.