Documentation and user experience about wasmer-python HOT 8 CLOSED

Those are good ideas.

What's the idiomatic tool to write documentation for Python?

from wasmer-python.

I think the most used is autodoc based on Python Sphinx, it is a docstrings processor based on reStructuredText directives. A lot of third-parties packages are hosted on https://readthedocs.org/

[UPDATE]
The only hook to setting docstrings I found in pyo3 is this one

As defined here, Rust comments can be accessed via module.__doc__

from wasmer-python.

NOTE: I see a lot of related things going on at github/RustPython like https://rustpython.github.io/demo/

from wasmer-python.

I am collecting as much examples in one of my repo, when they will reach a proper shape I will probably propose a PR to create a docs directory.

from wasmer-python.

Thank you. Tell me how I can help you, I've time for it.

from wasmer-python.

I am collecting examples and a sort of walkthrough https://github.com/Mec-iS/rust-wasm-python-101/tree/master/pywasm

from wasmer-python.

Note: it would be nice to have WebAssembly Studio mentioned in the README with few words to make new users visualise how a Rust function can be compiled to Wasm.

from wasmer-python.

There is now a beautiful documentation generated by pdoc3, https://wasmerio.github.io/wasmer-python/api/.

from wasmer-python.