Readthedocs vs Github pages
Posted: 20 Dec 2019, 02:31
Hi all,
so far, I had hosted the documentation on https://tenpy.github.io with github pages.
I have now tried to setup the documentation on https://tenpy.readthedocs.io as well, which is an awesome place hosting documentation for many, many python packages (and other stuff as well).
The nice thing there is that they have continuous integration, i.e. automatically update the docs after each new push to github.
Moreover, it supports keeping multiple versions of the documentation, i.e, you can still look up the doc of version 0.5.0 if a new version gets released.
They also have a different theme.
In contrast, for the github pages I had to setup an updating process myself, which is not so reliable and fast, and it can only host a single snapshot of the documentation.
Which one do you like better?
Should we update the README to link to readthedocs?
EDIT: corrected links
so far, I had hosted the documentation on https://tenpy.github.io with github pages.
I have now tried to setup the documentation on https://tenpy.readthedocs.io as well, which is an awesome place hosting documentation for many, many python packages (and other stuff as well).
The nice thing there is that they have continuous integration, i.e. automatically update the docs after each new push to github.
Moreover, it supports keeping multiple versions of the documentation, i.e, you can still look up the doc of version 0.5.0 if a new version gets released.
They also have a different theme.
In contrast, for the github pages I had to setup an updating process myself, which is not so reliable and fast, and it can only host a single snapshot of the documentation.
Which one do you like better?
Should we update the README to link to readthedocs?
EDIT: corrected links