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

Automatically generate output of code snippets in documentation #6

Closed
lars-reimann opened this issue Feb 7, 2023 · 1 comment · Fixed by #38
Closed

Automatically generate output of code snippets in documentation #6

lars-reimann opened this issue Feb 7, 2023 · 1 comment · Fixed by #38
Assignees
@lars-reimann
Labels
documentation 📖 Improvements or additions to documentation released Included in a release

Comments

@lars-reimann
Copy link
Member

lars-reimann commented Feb 7, 2023 •
edited
Loading

Is your feature request related to a problem? Please describe

Currently, we need to manually make screenshots of output images/create Markdown tables. It's easy to forget to update these images when we change the code in the documentation or the standard library itself.

Desired solution

Run the code directly and show the created outputs (mkdocs/mkdocs#2835).

Relevant links
@lars-reimann lars-reimann self-assigned this Feb 7, 2023
@lars-reimann lars-reimann added the documentation 📖 Improvements or additions to documentation label Feb 7, 2023
@lars-reimann lars-reimann transferred this issue from Safe-DS/DSL Mar 4, 2023
@lars-reimann lars-reimann moved this to Backlog in Library Mar 4, 2023
@lars-reimann lars-reimann mentioned this issue Mar 14, 2023
Merged
lars-reimann added a commit that referenced this issue Mar 14, 2023
@lars-reimann
docs: infrastructure to include notebooks as documentation (#38)
a1c0d97 
Closes #6.

### Summary of Changes

* Configure `mkdocs-jupyter` to be able to include notebooks in the
documentation
* Add an example notebook but don't include it in the navigation of the
documentation yet
  * Will be done later once we have better data in `safe-ds-examples`
@github-project-automation github-project-automation bot moved this from Backlog to ✔️ Done in Library Mar 14, 2023
@lars-reimann
Copy link
Member Author

🎉 This issue has been resolved in version 0.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@lars-reimann lars-reimann added the released Included in a release label Mar 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lars-reimann lars-reimann

Labels
documentation 📖 Improvements or additions to documentation released Included in a release
Projects
Library
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: infrastructure to include notebooks as documentation Safe-DS/Library
1 participant
@lars-reimann