lpython icon indicating copy to clipboard operation
lpython copied to clipboard

Docs: Proposal for adding docs

Open kmr-srbh opened this issue 1 year ago • 4 comments

I recently got to know about this amazing compiler for Python and I truly love the idea. However, I see that there are no docs available for the language features.

I wish to contribute to the project by filling this space.

I propose using docstrings following the NumPy style guide for documenting the modules, then using Sphinx to turn them to HTML pages.

I request feedback from everybody about the idea.

PS: I had joined the Zulip Chat group before, but then left as I thought the project was beyond my skill set. I request the group administrators to reactivate my account with email id - [email protected]

kmr-srbh avatar Feb 15 '24 13:02 kmr-srbh

To keep things uniform, go ahead and use LFortran's docs, and adapt them for LPython.

certik avatar Feb 15 '24 15:02 certik

@certik Okay! 👍

kmr-srbh avatar Feb 15 '24 15:02 kmr-srbh

Thanks. I also reactivated your user on Zulip.

certik avatar Feb 15 '24 20:02 certik

@certik Thanks a lot! 🙂

kmr-srbh avatar Feb 16 '24 07:02 kmr-srbh