Docs for Neural Evaluation Tree not generating

[WillemWybo]

The documentation for the Neural Evaluation Tree Simulator is not generating.

This is a cython .pyx file: neat/tools/simtools/net/netsim.pyx.

[benelot]

Eww, that is going to be a tough thing to do. It seems that sphinx does not read the doc strings from the .py file, but from the compiled .so file...(omg, why). Thus, the .pyx file needs to be compiled in some form as well before it can be added to the sphinx doc. @WillemWybo Is this compilable in some form just for sphinx doc purposes? We had some tricks in the past with files with missing dependencies, do we have similar problems here? I found some description on how to compile pyx in general (it will include running the setup.py). Not sure if running the setup.py will work, maybe we will have to write a sphinx-setup.py or something, but let us go one thing at a time.

[WillemWybo]

Are there some potentially useful bits in the (rather old) stackoverflow question?

[benelot]

The issue is not that we could not compile it, but that it could potentially contain again some dependencies that can not be resolved on the doc build server. From what I saw it just uses classic python and classic cython, right? There are no dependencies to neuron or similar?

[WillemWybo]

It also depends on some native C++ code (included with the package), but the C++ code doesn't have any special dependencies. So as long as the server can find the C++ compiler, it should compile (setup.py specifies gnu++11)