Documentation Page Based on DocStrings

[Suke0811]

Proposal

• Proposing to have a documentation webpage for learning and easier searchability.
• Use Mkdocs Material and DocString Extensions to extract the Docstrings automatically

Demo Branch

I pushed a new branch that includes the following pages:

• All previous tutorials (Mkdocs render Markdown, so no modification has been done)
• APIs docstrings, sources, and names have been parsed from the following folders (Not Complete):
  • edg_core
  • electronics_lib
  • electronics_model
• JLC PCB parts library rendered as a sortable table (only first 1000 items)

How to see the page

if you want to check the demo pages you can do:

checkout mkdocs branch

pip install -r .\docs\requirements.txt
mkdocs serve

Then you should see the link in the terminal (localhost)

The pages are only for concept, and they are not categorized and things could be broken.

Page sample:

Search

Table