Skip to content
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

Merged
merged 21 commits into from
Apr 19, 2024
Merged

Conversation

AnonymousCodes911
Copy link
Contributor

@AnonymousCodes911 AnonymousCodes911 commented Mar 14, 2024

fixes: #52
continued: #98
conformed the tox.ini file to linux
fixes to build_docs

conformed the `tox.ini` file
fixes to `build_docs`
-renamed build-test actions
-fixed tox
Added necessary dependencies
fixed-tox.ini
@matteobachetti
Copy link
Member

So, the idea is that this should build the documentation, not just convert the notebooks. Basically, install stingray, with this as submodule, and run tox -e build_docs

- added a `conf.py` file for sphinx build
- added `Index.rst` from Stingray
- fixed `build_test_notebooks` and `tox.ini`
@matteobachetti
Copy link
Member

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

fixes as per requirements
added `submodule update`
-currently scoped to my fork
@AnonymousCodes911 AnonymousCodes911 marked this pull request as draft March 21, 2024 13:05
changed the `working-directory`
these files are not needed as the workflow will run from Stingray's repo
fixes to build_docs
@matteobachetti matteobachetti marked this pull request as ready for review April 14, 2024 14:30
steps:
- name: Checkout stingray repo
uses: actions/checkout@v4
with:
repository: StingraySoftware/stingray
path: ./stingray

- name: Checkout notebooks repo
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this step needed?

Copy link
Contributor Author

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
Copy link
Member

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in latest commit

Copy link
Member

@matteobachetti matteobachetti left a 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

@matteobachetti matteobachetti merged commit ba9b322 into StingraySoftware:main Apr 19, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add tests for insertion into docs
2 participants