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

Docs/multiversion migration #315

Merged
merged 2 commits into from
May 7, 2021
Merged

Conversation

mschmidt87
Copy link
Member

@mschmidt87 mschmidt87 commented Apr 28, 2021

This PR migrates our docs from github pages to readthedocs. It also features multiversion and will currently host two versions:

  • latest (master branch)
  • 0.2.0 (this is actually not build from the 0.2.0 tag because this version does not have a config file for readthedocs, but from the 0.2.0_rtd branch which branches off from 0.2.0 and has the config file, therefore it is displayed as 0.2.0_rtd in the pulldown menu in the documentation)

This PR

  • deletes the deploy_docs.yaml config file for github actions
  • changes the docs banner link in the README
  • changes the version to 0.3.0.dev0

You can view the docs here: https://hal-cgp.readthedocs.io/en/latest/

Closes #251

Copy link
Contributor

@HenrikMettler HenrikMettler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for taking care of this :) Lgtm

Copy link
Member

@jakobj jakobj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks a lot, looks good! 🚀

one badge is not rendered properly for me on readthedocs, do you seen the same issue? i think it's the mypy badge.

@jakobj jakobj added this to the 0.3.0 milestone May 3, 2021
@HenrikMettler
Copy link
Contributor

thanks a lot, looks good! rocket

one badge is not rendered properly for me on readthedocs, do you seen the same issue? i think it's the mypy badge.

No everything looks fine for me...
image

@mschmidt87 mschmidt87 merged commit 9401b6c into master May 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Multi-version documentation
3 participants