Sphinx autodoc on github pages

[lneuhaus]

We should implement this in order to view the autodoc online, preferentially by having travis perform a build of the autodoc at each commit:
https://daler.github.io/sphinxdoc-test/includeme.html

[lneuhaus]

The good commands for building autodoc are described here:
http://gisellezeno.com/tutorials/sphinx-for-python-documentation.html

[lneuhaus]

These commands are:

cd doc/sphinx
sphinx-apidoc -f -o source/ ../../pyrpl/
make html

[SamuelDeleglise]

I think the make.bat and makefile are missing in the repository...

[lneuhaus]

08eb8ea
That is because you deleted it in a strange commit that was never discussed (see above). Could you comment on that commit (and the subsequent one) and undo the undesired stuff in it? To me, it never made sense but i didnt have time at the end of november to go through it with you

[lneuhaus]

1072a37

Sry, this is the commit i was talking about

[SamuelDeleglise]

Indeed, it looks like I suppressed too many things: the idea was

• move fpga folder towards hardware_modules --> We have discussed that afterwards and finally it was decided to put it back into pyrpl/ because it was central to the program and you wanted the FPGA code to be easily accessible
• I moved also some files that were at the /pyrpl root because they were now belonging to specific modules such as
  iir.py --> hardware_modules/iir/iir.py
  model.py -->software_modules/lockbox/model.py
• I deleted bodefit.py that was obsolete

And I guess I forgot to add the newly created folders to git before committing, that's why the displaced files reappear only in the next commit "added the folders"

Regarding the deletion of the "doc" folder, I must say this is intriguing, my best guess is that I tried to rebuild the doc from scratch, didn't succeed and I somehow ended up accidentally committing without the doc folder. Looking at the commit, we are in particular still missing all the files that were sitting at the root of /doc and that are not reconstructed by sphynx (sorry):

• tutorial.ipnb !!!!!
• sphinx/make.bat
• sphinx/Makefile
• custom_gui.png
• design of iir gui .... .png
• design of iir_gui.png
• design_of_iir_gui_better.png
• design_with_iir_gui.png
• gui.bmp
• High speed ...random generator.pdf
• IQmodule.png
• Redpitaya_HDL_memory_map....odt

They should definitely be reintegrated in the repo.

[SamuelDeleglise]

To make sure we are not doing the job twice, I am reintegrating them right now...

[lneuhaus]

moved info to wiki page "AutoDoc". Files above seem restored now