@ZoltánI forgot to mention yesterday that in my reference, each module is a minimal C example that you can start to hack right away.
Absolutely! Your examples are great!
@ZoltánI forgot to mention yesterday that in my reference, each module is a minimal C example that you can start to hack right away.
This is a fair point. I can drop the whole jupyter section, if you think it is distracting. In fact, all I have to do is exclude the source file in index.rst.pythoncoder wrote: ↑Tue Sep 03, 2019 9:12 am@v923z That's a great piece of work, an excellent explanation with really good code examples.
Just one comment. The Jupyter/IPython/Sphinx content at the start is quite daunting. The information on generating the documentation, while useful, isn't needed for those reading the doc online. Would those early sections be better at the end? For people unfamiliar with the tools you employ your doc is great, so long as they start reading somewhere around "The micropython code base".
No, I haven't seen that. Thanks for the pointer! I think I should mention these somewhere in the documentation.pythoncoder wrote: ↑Tue Sep 03, 2019 9:12 am
As a matter of interest have you seen these C stub generators? https://github.com/pazzarpj/micropython-ustubby and https://gitlab.com/oliver.robson/mpy-c-stub-gen.
Jupyter/ipython is vast now, having support for at least 40 different languages. But that is off the point. I elected to use that, because I wanted to have a single document, and one, where I can also compile, list files, etc. I you install their extensions, then you can have really nifty stuff in the browser. E.g., automatic table of contents, spell checking, code execution time measurement (very relevant in this particular case ), and a number of other things.pythoncoder wrote: ↑Wed Sep 04, 2019 5:59 amperhaps the Jupyter/IPython/Sphinx content warrants a separate doc, with some advocacy explaining exactly what they offer the MicroPython developer. While I have some familiarity with Sphinx I'm new to the other two. From a quick read IPython seems to offer a lot to CPython devs, but I couldn't see its relevance to MicroPython. But that may just be me failing to get the point...
Hi!v923z wrote: ↑Thu Sep 05, 2019 7:07 pmHi all,
I hope this is not getting overwhelming, but I have added a short section on how to work with string, and bumped the documentation version to 1.3. https://micropython-usermod.readthedocs ... index.html
Cheers,
Zoltán
I think, merging into the main micropython documentation would mean at least two things: