-
Notifications
You must be signed in to change notification settings - Fork 7
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
adding self-build of docs (publishes to gh-pages branch) #122
Conversation
I think this is a better option, that all devs will have an access to, compared to the readthedocs. |
It's not quite working yet - the module documentation is not being generated for some reason. |
Ok, it's working now - see test build from this configuration at https://bmaranville.github.io/orsopy/ |
What will the URL be? Will it conflict with https://github.com/reflectivity/reflectivity.github.io? |
By default, the new url would be https://reflectivity.github.io/orsopy , which seems to be automatically redirected to https://www.reflectometry.org/orsopy (currently resulting in a 404). We might have to fiddle with the settings on the redirects. |
I think it's mergeable once the redirects are sorted. Who do we ask about that? |
Actually it looks like it will work just fine - we will probably want to avoid making a folder called orsopy/ in our main website repo just to avoid conflicts. I uploaded a stub Discussion on folder vs. subrepo conflict: TL;DR: subrepo wins https://stackoverflow.com/a/26760818 |
You ask your delegated representative in the International Scattering Alliance, who is happy to help. Also, it's me. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great you got this going so quickly.
.github/workflows/docs_build.yml
Outdated
on: | ||
push: | ||
branches: | ||
- main |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we want to build it on every commit to main
. The docs should be up-to-date with the latest released version to avoid confusion. This can be done the same way as we do with the PyPI release, based on the tag of the commit.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That seems like a good idea. Do we also need to add a test that tries to build the docs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think so, the github action should show us if the build fails and you can still allow manual build.
Is this ready to merge? |
Yes, I think it's ready to merge. |
Do we know why the tests aren't passing? |
There was a coverage timeout |
That's what I thought. I don't have the power to tell Github to rerun them though, does someone have that power? |
I did rerun them... they still failed. I will try again. I don't completely understand why there is a service we are uploading files to... isn't there an equivalent test that can run natively on Github Actions? EDIT: I guess I can't re-run them. Never mind. |
The service gives a nice visualisation of the coverage. It isn’t 100% required, but nice to have and I don’t think it can be mirrored on GitHub actions. |
I have to say I really don't understand what is happening with the coveralls check... I copied the Why is it not running here? Why the 422 error? Mysteries. |
Let's merge this as is and then I will remove the coveralls thing from the Github action cause it is just a faff. |
Hey, it worked! Check out https://www.reflectometry.org/orsopy/ |
We can build the docs ourselves instead of using readthedocs, which is an external point of failure.
This will make it easier to maintain and debug the documentation build (all code owners have access)