-
Notifications
You must be signed in to change notification settings - Fork 33
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
Notebook Tests #99
Notebook Tests #99
Conversation
-renamed build-test actions -fixed tox
Added necessary dependencies
So, the idea is that this should build the documentation, not just convert the notebooks. Basically, install stingray, with this as submodule, and run |
- added a `conf.py` file for sphinx build - added `Index.rst` from Stingray - fixed `build_test_notebooks` and `tox.ini`
I meant literally to install stingray, update the notebooks submodule to the version of notebooks of the PR, and run the stingray tox test to build the docs. You can do all these steps inside the test. There is no need to copy pieces of the Stingray documentation in the notebooks repository |
steps: | ||
- name: Checkout stingray repo | ||
uses: actions/checkout@v4 | ||
with: | ||
repository: StingraySoftware/stingray | ||
path: ./stingray | ||
|
||
- name: Checkout notebooks repo |
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.
Is this step needed?
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.
No, I fixed the branch in the latest commit so this is not required here, thank you!
- name: Update submodules | ||
run: | | ||
cd ./stingray |
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.
What you are updating here is the notebook submodule version already in stingray. You should add an instruction to checkout the exact version of the notebooks of the PR
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.
fixed in latest 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.
Yeah! We have tests!
Thanks @AnonymousCodes911
fixes: #52
continued: #98
conformed the
tox.ini
file to linuxfixes to
build_docs