Skip to content
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

Merged

Conversation

JonathanWenger
Copy link
Contributor

@JonathanWenger JonathanWenger commented Jul 17, 2020

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:

  • merge PR into development
  • merge development into master
  • Update settings in readthedocs dashboard
  • Update repository website to probnum.readthedocs.io
  • Update repository settings to not serve the gh-pages branch
  • Delete gh-pages branch
  • remove travis's github token

@JonathanWenger
Copy link
Contributor Author

This closes #84 and #7 .

@JonathanWenger
Copy link
Contributor Author

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 probabilistic-numerics/probnum from JonathanWenger/probnum.

@JonathanWenger
Copy link
Contributor Author

Note: Docs for master will not build at probnum.readthedocs.io until changes from this PR are merged into master.

@JonathanWenger JonathanWenger marked this pull request as ready for review July 17, 2020 13:19
Copy link
Collaborator

@nathanaelbosch nathanaelbosch left a 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).

CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
setup.cfg Show resolved Hide resolved
.readthedocs.yml Show resolved Hide resolved
.travis.yml Outdated Show resolved Hide resolved
.readthedocs.yml Outdated Show resolved Hide resolved
@nathanaelbosch
Copy link
Collaborator

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"?

@JonathanWenger
Copy link
Contributor Author

JonathanWenger commented Jul 17, 2020

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
We might want a third opinion (e.g. @pnkraemer) here on what is better. Note that the documentation structure in the readthedocs template is still subject to change (in particular the structure could be more coherent).

@nathanaelbosch
Copy link
Collaborator

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 :)

Copy link
Collaborator

@nathanaelbosch nathanaelbosch left a 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!

@JonathanWenger JonathanWenger self-assigned this Jul 21, 2020
@JonathanWenger JonathanWenger added the documentation Improvements or additions to documentation label Jul 21, 2020
@JonathanWenger JonathanWenger marked this pull request as ready for review July 21, 2020 16:01
@JonathanWenger
Copy link
Contributor Author

JonathanWenger commented Jul 21, 2020

Update:
The following larger changes are made by this commit:

  • The documentation will from now on be hosted by ReadTheDocs at https://probnum.readthedocs.org
  • The documentation can be viewed for different branches and releases
  • The documentation style now is based off of sphinx_rtd_theme instead of bootstrap

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:

  • Menu structure
  • Intuitiveness of page (organization, page names, is information easy to find?)

Added Pages:

.readthedocs.yml Show resolved Hide resolved
docs/source/development/documentation.rst Show resolved Hide resolved
docs/source/development/documentation.rst Outdated Show resolved Hide resolved
docs/source/index.rst Show resolved Hide resolved
docs/source/introduction/probabilistic_numerics.rst Outdated Show resolved Hide resolved
@nathanaelbosch
Copy link
Collaborator

nathanaelbosch commented Jul 22, 2020

My feedback, as discussed:

  • use api names for the api documentation: "probnum.diffeq" instead of "Differential Equations", "probnum.utils" instead of "Other", etc
  • different tutorial structure:
    • Remove "Case Studies" and "Advanced" since they are empty
    • Maybe use that level of structure (where "Advanced" was) to structure into diffeq, linalg, etc

@JonathanWenger JonathanWenger merged commit 14731df into probabilistic-numerics:development Jul 22, 2020
@JonathanWenger JonathanWenger deleted the docs-update branch August 17, 2020 06:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
3 participants