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

Tutorial directives #195

Merged
merged 25 commits into from
Aug 17, 2023
Merged

Tutorial directives #195

merged 25 commits into from
Aug 17, 2023

Conversation

RLKRo
Copy link
Member

@RLKRo RLKRo commented Aug 10, 2023

Description

Add two tutorial directives (one for inserting installation cells, and one for inserting documentation links).

Tutorial dependencies separated from test dependencies in setup.py.

Also, added a test to ensure that all dependencies listed in tutorials are correct (the test is currently disabled in all workflows since is takes ~2 minutes to complete). Removed most of other test_tutorials tests since this one covers them. (returned because coverage)

I'm currently considering removing the test and instead converting tutorials to notebooks (and running them) inside isolated venvs (and using converted notebooks in documentation).

Checklist

  • I have covered the code with tests
  • I have added comments to my code to help others understand it
  • I have updated the documentation to reflect the changes
  • I have performed a self-review of the changes

@RLKRo RLKRo added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 10, 2023
@RLKRo RLKRo self-assigned this Aug 10, 2023
@RLKRo RLKRo marked this pull request as ready for review August 10, 2023 12:56
@RLKRo RLKRo mentioned this pull request Aug 14, 2023
4 tasks
Copy link
Collaborator

@pseusys pseusys left a comment

Choose a reason for hiding this comment

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

I would also like to see documentation linking implementation here.

.github/workflows/test_coverage.yml Show resolved Hide resolved
.github/workflows/test_coverage.yml Outdated Show resolved Hide resolved
.github/workflows/test_full.yml Outdated Show resolved Hide resolved
.github/workflows/test_full.yml Outdated Show resolved Hide resolved
.github/workflows/test_full.yml Outdated Show resolved Hide resolved
tests/tutorials/test_dependencies.py Outdated Show resolved Hide resolved
tests/tutorials/test_dependencies.py Outdated Show resolved Hide resolved
tests/tutorials/test_dependencies.py Outdated Show resolved Hide resolved
tests/tutorials/test_dependencies.py Outdated Show resolved Hide resolved
docs/source/utils/notebook.py Show resolved Hide resolved
@RLKRo RLKRo requested a review from pseusys August 16, 2023 08:50
@kudep kudep merged commit feb4fc1 into dev Aug 17, 2023
@kudep kudep deleted the feat/tutorial-templates branch August 17, 2023 09:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants