You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I don't know how readthedocs updates, but when I look at https://www.reflectometry.org/orsopy/fileio_usage.html I get the old version of the file (not what has been updated here). I don't have time right now to look into it, but am writing this as a reminder
I can see the desire to keep the code and documentation in agreement, but then we should be able to make documentation only pushes and have them reflected to users. Maybe I'm just not following the expected workflow though, so please let me know!
Activity
andyfaff commentedon Apr 10, 2025
The workflow only runs on a release.
jfkcooper commentedon Apr 10, 2025
Ahh that makes sense! Any concerns if I add a hook to the workflow to run it manually and update the docs?
andyfaff commentedon Apr 10, 2025
See #122 for background on this.
The docs are only supposed to be built on release, so the code matches the doc.
(I prefer readthedocs approach where you get both)
aglavic commentedon Apr 11, 2025
It's possible to add this as a workflow-displatch runner to be able to do doc fixes between releases.
jfkcooper commentedon Apr 16, 2025
Having read #122 I'm still not quite sure why it isn't pulling in the current version of 'fileio_usage.rst'.
Am I right in thinking that we now have two (potentially different) documentation pages - https://www.reflectometry.org/orsopy/ and https://orsopy.readthedocs.io/en/latest/ ?
I can see the desire to keep the code and documentation in agreement, but then we should be able to make documentation only pushes and have them reflected to users. Maybe I'm just not following the expected workflow though, so please let me know!