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.

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

Merged
merged 46 commits into from
Mar 4, 2024
Merged

Conversation

pmeier
Copy link
Member

@pmeier pmeier commented Oct 19, 2023

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:

  • Local LLMs: this was an absolute bare bones example with no narration / text. Plus, it is not up to date anyway and thus cannot be run. We should re-add such an example in the future.
  • S3 documents: this functionality was moved into ragna-aws anyway, so we don't need to keep the example.

For that we gain one more example to showcase streaming LLM responses.

@pmeier pmeier mentioned this pull request Oct 19, 2023
8 tasks
@pmeier pmeier marked this pull request as draft October 20, 2023 22:11
@pmeier
Copy link
Member Author

pmeier commented Dec 18, 2023

@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 await and other async syntax without the need of wrapping everything in asyncio.run or the like.

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/

environment-dev.yml Outdated Show resolved Hide resolved
@pmeier pmeier mentioned this pull request Jan 19, 2024
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@pmeier pmeier changed the title [DONOTMERGE] mkdocs-gallery example mkdocs-gallery example Jan 30, 2024
@pmeier pmeier linked an issue Feb 2, 2024 that may be closed by this pull request
@pmeier pmeier added this to the 0.2.0 milestone Feb 2, 2024
@pmeier
Copy link
Member Author

pmeier commented Feb 12, 2024

Blocked by #316 and #317.

@pmeier pmeier marked this pull request as ready for review February 12, 2024 15:04
@pmeier pmeier added the area: documentation 📖 Improvements or additions to documentation label Feb 12, 2024
@pmeier pmeier changed the title mkdocs-gallery example use mkdocs-gallery for example / tutorial documentation Feb 12, 2024
@pavithraes
Copy link
Member

pavithraes commented Mar 4, 2024

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 DeprecationWarning - but seems like that needs to be resolved separately.

@pmeier pmeier merged commit 7c210c3 into main Mar 4, 2024
12 checks passed
@pmeier pmeier deleted the mkdocs-gallery branch March 4, 2024 20:01
@pmeier pmeier mentioned this pull request Mar 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation 📖 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

META - Create & Update Examples
2 participants