Build nrp documentation?

#1

hey,
how do you build the nrp documentation from code with sphinx?
does it work somehow automatically?

thanks,
camilo

#2

You can run make doc or make doc-pdf. The former will create a HTML output while the latter will produce a pdf file, assuming that you have LaTeX installed. However, I am afraid we did not really care for the documentation for quite some time, so if you build the documentation at the moment, you will be getting lots of errors and the documentation will be incomplete (there is no script that automates autodoc, at the moment).

make doc and make doc-pdf will work in any Python repository. The general documentation is in the hbp-documentation repo, in the folder for neurorobotics. There is also a makefile for this one.

#3

ok!!!
thanks georg!
I algo got the docu for individual repos working.
I’ll check out the documentation repo.