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

Render wradlib-notebooks as own document at readthedocs #79

Closed
kmuehlbauer opened this issue Feb 25, 2023 · 1 comment
Closed

Render wradlib-notebooks as own document at readthedocs #79

kmuehlbauer opened this issue Feb 25, 2023 · 1 comment

Comments

@kmuehlbauer
Copy link
Member

Currently the notebooks are rendered via GitHub Actions and then pulled in by wradlib-docs to be rendered in the wradlib documentation.

This workflow is inherently error prone. To get this workflow more maintainer friendly the idea is:

  1. DOC: reintroduce doc into wradlib repository wradlib#619 over at wradlib
  2. a. render the notebooks on push to wradlib and push them to devel-branch (or tag-branch) here depending on wradlib version commit
    b. render notebooks here and push devel-branch (or tag-branch)
  3. render new notebook-documentation on rtd with the just rendered branch
  4. a. link the notebook-docs as subproject to wradlib documentation from the above rtd
    b. render the notebooks within new wradlib doc rtd processing after (2.a)

This might take a while to set up and test thoroughly. For the time being the automatic rtd builds are disabled here #78 and on wradlib.

@kmuehlbauer
Copy link
Member Author

It looks like with wradlib/wradlib#619 we have everything in place.

The notebooks are rendered either on push to wradlib or here on push to main. ReadTheDocs is triggered and the documentation is build as usual. That's for now the minimal-invasive action.

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

No branches or pull requests

1 participant