PyMine-Server
PyMine-Server copied to clipboard
Create docs
- Add docstrings to classes and functions in the sphinx style (use docblock-python or a similar plugin)
- Create documentation on https://readthedocs.org using reStructured text
- This should be as detailed as possible
- Ask me on Discord if you want me to explain something or make a description / docs for it.
For people who don't know reStructured text, consider checking out pandoc
for transferring your preferred format (Markdown, HTML, etc) to reStructured.
Hi, I would like to help with this issue if it is still not being worked on. However, I am new to working on a project at this scale and I do not understand how the code works, let alone how to document this. Any advice for starting?