Update documentation based on gap analysis #181
Conversation
* Add docs and update example * Use literalinclude
* Example 1 * Example 2 * Example 3 * Limitations
* Extend docs for Debugging * Improve docs structure
* Added docs * Added note * Small fixes * Add docs for python features * Fix headers
* Added docs * Added note * Added docs and example * Use autodoc Co-authored-by: Sergey Pokhodenko <sergey.pokhodenko@intel.com>
* Added docs and examples for memory management
|
@PokhodenkoSA I have started making edits and will be pushing changes to the branch. Please do not merge yet. |
|
@reazulhoque @PokhodenkoSA The section under features is totally out of date and mentions MS138 etc. that are irrelevant. Can you comment the whole thing out and remove it from the gh-pages. |
|
Also a general comment, let us avoid the term |
|
@diptorupd I have added several fixes. Please, see last commits. |
I did a full review and have pushed several changes. I tried to polish up what I can, but am stopping for now. I also restructured the organization of the docs. The overall quality of the docs is still very rough, but we have to go with what we have for now and then keep updating it. Note that there are sections (e.g, the random functions sections) that I have removed as I could not quite fit it with the rest of the text. The files still are left in the repo, do not add them back. @reazulhoque Add a section under the @PokhodenkoSA Polish up the @akharche Since the GDB guide was the best written :) I nominate you to proof-read the whole doc once more and edit as needed. Things to look out will be use of Let us plan for a |
Done. |
Done |
|
Done. |
…ev func from another dev func
|
I have restored examples broken after cb77307. |
Closes #145