-
Notifications
You must be signed in to change notification settings - Fork 1k
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
updating the docs without publishing a release #867
Comments
RTD docs already do this:
Although, I'm not currently relying on RTD builds as a proper reference because the "Related Pages" have misplaced admonitions at the bottom (a bug in breathe). |
I think this would be a pretty good idea, there are probably lots of times the docs can be updated without a release being made, plus RPi/Linux users would be compiling from source in many cases. Thinking we should do this for all the RF24 repos. |
Oops, I forgot to mention that was part of my intention. |
@TMRh20 @Avamander FYI
Manually running this workflow on any other branch will not publish the docs (as usual). |
This wasn't needed for RF24Audio. If I missed a repo, let me know. The CirPy & pyRF24 repos already rely on RTD, so we don't need this for them either. |
Nice work! |
I just had a thought that would allow us to publish docs without having to publish a release... It would involve a manually triggered the docs CI from the master branch (see
workflow_dispatch
event).Of course this should be used lightly because the we don't want to publish docs that don't correspond to latest release.
The text was updated successfully, but these errors were encountered: