-
Notifications
You must be signed in to change notification settings - Fork 27
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
use mkdocs-gallery for example / tutorial documentation #89
Conversation
Conflicts: environment-dev.yml environment.yml mkdocs.yml pyproject.toml
@pavithraes In smarie/mkdocs-gallery#90 I'm working on adding support for async galleries. With that, writing a gallery feels exactly like a notebook in the sense that we can use I've switched this PR to the branch where I'm adding async galleries. Have a look at the script that is part of this PR and how it renders: https://ragna--89.org.readthedocs.build/en/89/generated/gallery/example_python_api/ |
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Thanks for this PR, @pmeier :) Overall, this looks good. My main (non-blocking) comment in around consistency in narrative text. It'll be nice to use a standard style guide for all narrative elements. However, we can always update for this later, so we can merge for now. :) Edit: I do see that the CI is failing with a |
Per title. This PR removes the
examples/
folder and static markdown examples / tutorials and replaces them with executable gallery scripts.We are going to lose the following two examples for now:
ragna-aws
anyway, so we don't need to keep the example.For that we gain one more example to showcase streaming LLM responses.