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.

Sign up for GitHub

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

Jump to bottom

Test tutorials #399

Merged
merged 12 commits into from
Feb 12, 2025
Merged

Test tutorials #399

merged 12 commits into from
Feb 12, 2025

Conversation

ElliottKasoar
Copy link
Member

@ElliottKasoar ElliottKasoar commented Feb 3, 2025 •
edited
Loading

Resolves #386

Adds basic tutorials from https://github.com/stfc/janus-tutorials, with minor formatting changes.

These are built as part of the publishing workflow, so must run successfully before janus-core is published to PyPI.

An example: https://elliottkasoar.github.io/janus-core/tutorials/single_point.html

To do:

  • Add note in dev docs for building/running, including need to install pandoc on system

@ElliottKasoar ElliottKasoar added documentation Improvements or additions to documentation enhancement New/improved feature or request labels Feb 3, 2025
@ElliottKasoar ElliottKasoar self-assigned this Feb 3, 2025
ElliottKasoar
ElliottKasoar commented Feb 6, 2025
View reviewed changes
docs/source/user_guide/python.rst Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/source/user_guide/python.rst Outdated Show resolved Hide resolved
@ElliottKasoar ElliottKasoar force-pushed the test-tutorials branch 2 times, most recently from d698414 to 77ab91d Compare February 6, 2025 15:54
@alinelena alinelena self-requested a review February 12, 2025 11:03
alinelena
alinelena previously approved these changes Feb 12, 2025
View reviewed changes
oerc0122
oerc0122 reviewed Feb 12, 2025
View reviewed changes
Copy link
Collaborator

@oerc0122 oerc0122 left a comment

Choose a reason for hiding this comment

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

Mostly looks good, just a couple of queries.

.github/workflows/ci.yml Show resolved Hide resolved
.github/workflows/publish-on-pypi.yml Show resolved Hide resolved
.github/workflows/publish-on-pypi.yml Show resolved Hide resolved
docs/source/developer_guide/get_started.rst Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
@ElliottKasoar
Copy link
Member Author

(Rebased, and fixed the dependency grouping as suggested by @oerc0122)

@ElliottKasoar ElliottKasoar merged commit 24a3bf4 into stfc:main Feb 12, 2025
9 checks passed
@ElliottKasoar ElliottKasoar deleted the test-tutorials branch February 12, 2025 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oerc0122 oerc0122 oerc0122 approved these changes

@alinelena alinelena alinelena left review comments

Assignees

@ElliottKasoar ElliottKasoar

Labels
documentation Improvements or additions to documentation enhancement New/improved feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Test tutorials
3 participants
@ElliottKasoar @alinelena @oerc0122