Using Marimo for package documentation

At a glance

The community member is considering building interactive documentation for their Python package using the Marimo framework, which allows communication with a large language model like Claude. They have a few questions about the general feasibility, usability, speed, and browser rendering of this approach, and are also wondering about the suggested workflow, such as embedding Marimo pages in a generic documentation platform.

The comments suggest that this is a viable approach, with one community member mentioning they use Sphinx with Markdown and a WASM playground to achieve similar functionality. Another community member is interested in having all their documentation in Marimo, and the third community member believes this should be possible, though they note that some improvements, like automatic cross-linking, may be needed.

There is no explicitly marked answer in the provided information.

ggiladrubin

Hey all, I'm pretty excited about this new framework!
I'm thinking of a way to build docs for my python package and I thought of trying something new - perhaps building an interactive documentation using marimo.
This will also allow me to communicate back and forth with an LLM like Claude. Jupyter notebooks don't allow that in a straightforward way.

I have a few questions:

Do you it's generally a good idea? in terms of usability, speed, ability to render in browsers and other things I haven't thought of?
If you think it's worth a try - what workflow would you suggest? using a generic documentation platform and just embed the pages in them?

Thanks in advance!
Gilad

3 comments

MMyles Scolnick

This is totally doable - we do this for our own docs.

We use sphinx with markdown and wasm playground to achieve this

ggiladrubin

I see that most of your docs is not in marimo, but markdown. There are some snippets from marimo... I'm thinking of having all of my documentation in marimo 🙂

MMyles Scolnick

oh I see - I haven’t see anyone do that yet but that should be very possible.

You can definitely write them in marimo and then export to html via the CLI. I am sure we can improve some thing (like automatic cross linking) - but I don’t know yet what until we actually try

Add a reply

Get help from the marimo community

Using Marimo for package documentation