Create project specific API Reference

Posted on
  • Espruino supports different boards and can be customized by defines like Net, Gtaphics, Neopixel etc.
    May be, you have your own extensions. In that case it would be helpful to have an API documentation for your project.
    In a first try I've added -BBoard parameter to build_docs.py, which changes argument to call common.get_jsondata, and adds a define in switch-path which handles -B parameters.

    This would open the option to create board specific API documentation during make by calling
    python build_doc.py $(FAMILY) $(WRAPPERSOURCES)
    And then add it to board zip file.

    If this is of general interest I would open a pull request

  • Post a reply
    • Bold
    • Italics
    • Link
    • Image
    • List
    • Quote
    • code
    • Preview
About

Create project specific API Reference

Posted by Avatar for JumJum @JumJum

Actions