-
Notifications
You must be signed in to change notification settings - Fork 41
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
Include SasData documentation in SasView #2672
Conversation
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.
Looks good.
- I assume 29: Building sasdata documentation sasdata#53 will get get merged first and then
ci.yml
will get updated prior to merging this - Is it worth folding the
sphinx-apidoc
andsphinx-build
calls that are duplicated here and insasdata/.github/workflows/test.yml
into thedoc/Makefile
? (in the same way asbumps
andsasmodels
have done so that it's a uniform interface to the three) retrieve_sasdata_docs
is currently necessary but this sort of layout is not nice to new contributors with the complexity it brings to getting started with sasview, also not nice for downstream people who will have to come up with ways of circumventing it.
All this work reminds me of #2421 again btw.
That's the expectation.
Good catch. I missed that. I'll make those changes.
Agreed. At the last code camp, we started to look into combining everything into a single repository (sasmodels and sasdata included) and using CI to create separate releases for each 'external' repo. This would eliminate a lot of this hassle, including your first point, but continue to allow a cleaner separation of the different code sections. That is still a WIP. |
Tested on Mac. Works fine. In my opinion we should merge it |
@krzywon any objections to merging it? |
@wpotrzebowski, SasView/sasdata#53 must be first merged and then I need to point the CI here to sasdata master. |
Tested on Mac. As discussed at the call I am merging it. |
Description
This PR integrates the documentation generated by the
sasdata
package into SasView usingbuild_sphinx.py
and CI.This is reliant on the work in SasView/sasdata#53 and uses the associated
sasdata
branch inci.yml
.How Has This Been Tested?
CI output
Review Checklist (please remove items if they don't apply):