Skip to content

Conversation

@alexhroom
Copy link
Collaborator

This PR fixes #18 by splitting the examples folder into a separate folder for each language. The MATLAB folder contains the tutorials, with HTML exports of the live scripts embedded. The Python folder contains Jupyter notebooks converted via nbsphinx.

@alexhroom alexhroom marked this pull request as ready for review January 29, 2025 12:10
Copy link
Collaborator

@StephenNneji StephenNneji left a comment

Choose a reason for hiding this comment

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

Thanks for this, see comments

  1. Please update README with instruction to build example and install Pandoc
  2. The instruction to run the Python examples have been removed and I think that information is arguably more important than adding the notebooks so we have to add them back. We could consider moving the Examples up one level out of the user guide so the navigation will look like
    Home Installation User Guide Examples References
    This should give more flexibility so we can have instructions to run the examples and notebooks separately.
  3. I don't know what's going on here with the duplicate numbers
    Screenshot 2025-02-06 130246

@alexhroom
Copy link
Collaborator Author

alexhroom commented Feb 6, 2025

@StephenNneji regarding

The instruction to run the Python examples have been removed and I think that information is arguably more important than adding the notebooks so we have to add them back...

there is a setting for nbconvert where you can add a prolog to notebooks, with information on how to run them (see e.g. the nbconvert docs, entirely written in Jupyter, where they use the prolog to provide download and binder links). Would adding the information on how to run the scripts to the prolog do?

@StephenNneji
Copy link
Collaborator

there is a setting for nbconvert where you can add a prolog to notebooks, with information on how to run them (see e.g. the nbconvert docs, entirely written in Jupyter, where they use the prolog to provide download and binder links). Would adding the information on how to run the scripts to the prolog do?

I don't know how it will look but we also need instructions for people running the examples as a script or function not just the notebook. People might ignore the prolog and assume its for the notebook users

@alexhroom
Copy link
Collaborator Author

@StephenNneji the prolog doesn't have to resemble the one in the example I gave: it just lets you put a block of text before the notebook. This would have the same structure as the MATLAB examples

Copy link
Collaborator

@StephenNneji StephenNneji 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, please see comments

@alexhroom alexhroom merged commit de5ddfd into RascalSoftware:main Feb 19, 2025
1 check passed
@alexhroom alexhroom deleted the 18-jupyter-notebooks branch February 19, 2025 10:31
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.

Integrate jupyter notebook examples into docs

2 participants