Fix docs gha #177
Fix docs gha #177
Conversation
|
The docs are building and the push to gh-pages, from a PR, is failing as expected. |
|
Docs are build and the failed linkcheck is expected b/c the file will be on that URL after the merge of this PR. See https://github.com/python-windrose/windrose/runs/6324143101?check_suite_focus=true#step:6:91 |
| @@ -2,8 +2,7 @@ name: Build and Deploy docs | |||
|
|
|||
| on: | |||
| push: | |||
| branches: | |||
| - [master, main] | |||
| branches: [master, main] | |||
There was a problem hiding this comment.
@scls19fr this should fix the error that is happening on master.
| @@ -14,7 +14,7 @@ Welcome to windrose's documentation! | |||
| :caption: Contents: | |||
|
|
|||
| Install <install.rst> | |||
| Usage <usage.rst> | |||
| Usage <usage-output.ipynb> | |||
There was a problem hiding this comment.
This PR changes how we this part of the documentation. Instead of a rst file we have a notebook that is run at build time, to ensure it is working. That reduces the number of files we need to sync (screenshots, instructions in multiple places, etc) and make it easier for users b/c they can download the notebook and run the docs if they want to follow along.
… up when changes happen
Also, testing with nbsphix, not ready for review yet.