search

nengo / nengo-extras

Extra utilities and add-ons for Nengo
https://www.nengo.ai/nengo-extras
Other
5 stars 8 forks source link

Add GEXF documentation #56

Closed jgosmann closed 6 years ago

jgosmann commented 6 years ago

It was requested that I add some documentation/tutorial for PR #54. So far there is no proper documentation for this repository and thus not really a place to put that. This PR adds the files required to build the a documentation with python setup.py build_sphinx (copied to a large degree from Nengo core). At the moment the documentation just includes the repository readme and contains autogenerated documentation for all of the repository. There is clearly potential to improve that and give it a better structure, but that can be done as separate PRs and I would like to focus on the documentation for my PR instead of going through all the existing stuff in this repository.

hunse commented 6 years ago

When I try to build the docs with python setup.py build_sphinx, I get

To build the documentation, nengo_extras and guzzle_sphinx_theme must be installed in the current environment. Please install these and their requirements first. A virtualenv is recommended!

I have both of these installed in my virtualenv, so I'm not sure why it's saying this. Also, nengo doesn't use guzzle_sphinx_theme, so why is it required here?

EDIT: I realized that nengo was recently changed to use guzzle. Also, it seems the source of my problem is the import nbsphinx line at the top of conf.py. Nengo doesn't have this, and if I comment it out, this works for me. Is it needed?

hunse commented 6 years ago

All I had to do was install nbsphinx. It wasn't in the requirements.

jgosmann commented 6 years ago

The nbsphinx import should be removed for now. I missed to remove that line (at some point we might also include examples/notebooks in the documentation I suppose, but it might be best to get nengo/nengo#1349 reviewed and then include equivalent changes here).

hunse commented 6 years ago

Ok, that's fine.

tbekolay commented 6 years ago

I didn't realize this PR was adding general docs when I recently made the nengo-extras docs due to the title change, so apologies that this PR is now obsolete. Even the deepview compat change is in master now, so I'm closing this (but please reopen if I've missed anything).