Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Include examples as notebooks in the documentation #197

Merged
merged 7 commits into from
Oct 25, 2023

Conversation

RemiLehe
Copy link
Member

@RemiLehe RemiLehe commented Oct 20, 2023

This PR uses nbsphinx so that we can use notebooks as source files in the Sphinx documentation.

The notebooks are then nicely formatted in the chosen style of the documentation. In addition, they are run by readthedocs as part of building the documentation - which provides one form of automatic testing. (The readthedocs build will fail if the notebook is obsolete and does not work anymore.)

In particular, our first example (gaussian laser) has now been converted in notebook format.

Future PRs will add more notebooks in the tutorials folder.

@RemiLehe RemiLehe requested a review from AngelFP October 20, 2023 23:58
@RemiLehe RemiLehe changed the title [WIP] Include examples as notebooks in the documentation Include examples as notebooks in the documentation Oct 21, 2023
Copy link
Member

@AngelFP AngelFP left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for this!

@RemiLehe RemiLehe merged commit 9eaa975 into LASY-org:development Oct 25, 2023
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants