New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Migration to ReadTheDocs #103
Migration to ReadTheDocs #103
Conversation
You can view the documentation generated by this PR at https://probnum.readthedocs.io. As soon as the PR is merged I will swap the underlying repo at ReadTheDocs to |
Note: Docs for master will not build at |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good job overall! I just added a few comments, but none of which is really crucial to fix. Probably the main point is the choice of how to properly name the two versions (default/development, master/development, stable/latest, or anything else).
I also wondered: In this PR you ported the documentation in its current style to readthedocs. Does this only represent a migration to another domain (with additional functionality regarding multiple documentations of course!), or does this also include a statement/decision about the stylistic choice for the ProbNum documentation, i.e. "our current layout" vs "the common readthedocs layout"? |
In order to reach a decision I ported our thematic choices of the docs to the readthedocs template. See here: https://probnum.readthedocs.io/en/docs-style/index.html |
Awesome work Jonathan! I'm really impressed by seeing the documentation in both styles. Personally, I think I slightly prefer the readthedocs layout, but I find it really hard to decide between both. But it really is awesome that we can compare both side by side :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me!
Update:
During this migration I also changed much of the structure of the documentation and added some new sections to the documentation. During review I am mostly interested in feedback on the following: General:
Added Pages:
|
My feedback, as discussed:
|
This PR migrates the documentation from being built by Travis and being deployed to the
gh-pages
branch to being built and hosted by ReadTheDocs. This has the primary advantage that different versions of the documentation for different branches can be easily built and viewed in parallel.Note: This changes the domain of the documentation from https://probabilistic-numerics.github.io/probnum/ to https://probnum.readthedocs.io
Todos:
development
development
intomaster
probnum.readthedocs.io
gh-pages
branchgh-pages
branchremove travis's github token