search

datajoint / datajoint-python

Relational data pipelines for the science lab
https://datajoint.com/docs
GNU Lesser General Public License v2.1
170 stars 85 forks source link

Generate documentation #19

Closed eywalker closed 9 years ago

eywalker commented 10 years ago

Generate documentation forDataJoint semi-automatically from in-code documentations. Generated documentations should be hosted on datajoint-python project site.

fabiansinz commented 9 years ago

Documentation can now be found on http://datajoint-python.readthedocs.org/en/latest/. I haven't tested whether the github webhook runs smoothly and we might need to fix a few things along the way so that readthedocs can build the doc on their servers. So far, I made every module that readthedocs complained about a mock module (see doc/conf.py). But at least it builds the documentation I expected.

The next step is to massively extend the documentation of the package. Do you think that should run under this issue or should we create new one and close this one?

eywalker commented 9 years ago

Let's create a new issue to discuss documentation and close this one.