readthedocs vs self-build + githubpage hosted

[DerThorsten]

Maintaining a building documentation on readthedocs is a pain in the ass:

• Hard / Impossible to debug
• No GPU => all examples which shall produce plots rely somehow on a cuda GPU. We will never get this on readthedocs => the example gallery will look poor on readthedocs

Building the docs by ourselfs and host them via https://pages.github.com/ is not very hard, It just means we need do this on a regular basis. But we get a supernice auto example gallery and it is not fragile at all.

@nasimrahaman what do you think?

[nasimrahaman]

@DerThorsten I like the idea. Let's set it up when you're in office.

[nasimrahaman]

@constantinpape Opinions?

[constantinpape]

Sounds good to me.

[DerThorsten]

https://inferno-pytorch.github.io/inferno/html/index.html this is what I got so far. I don't know why all the colors and formating is missing. Anyone any clue? I just pushed the build html folder to the gh-pages branch (https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/)

Edit: https://stackoverflow.com/questions/18023908/static-resources-not-loading-on-git-hub-pages maybe this is relevant

Edit2: IT IS WORKING https://inferno-pytorch.github.io/inferno/html/index.html

[DerThorsten]

Well, I don't like to toot my own horn, but... https://inferno-pytorch.github.io/inferno/html/auto_examples/plot_unet_tutorial.html#sphx-glr-auto-examples-plot-unet-tutorial-py (this example is made from a single python file https://github.com/inferno-pytorch/inferno/blob/super-dev/examples/plot_unet_tutorial.py )

[nasimrahaman]

Nice! Then let's stick to self built docs.

[DerThorsten]

who is volunteering to update the docs change all the urls? (I do not have a GPU...I do not want to run all the unet example on the cpu all the time, except from that I would still be willing to help maintaining the docs / the overall project)