summaryrefslogtreecommitdiff
path: root/stmhal/gendoc.py
AgeCommit message (Collapse)Author
2014-05-10tools: Move gendoc.py to tools, and make it a little more generic.Damien George
2014-05-03stmhal: Add example use to RTC doc; add rtc.c to gendoc.py.Damien George
2014-05-02stmhal: Add documentation for DAC and Timer classes.Damien George
2014-04-30stmhal, docs: Small changes to URL links; adds list of files if none given.Damien George
This documentation is now available at micropython.org/doc/
2014-04-29stmhal: Add documentation in comments, and script to generate HTML.Damien George
Decided to write own script to pull documentation from comments in C code. Style for writing auto generated documentation is: start line with /// and then use standard markdown to write the comment. Keywords recognised by the scraper begin with backslash. See code for examples. Running: python gendoc.py modpyb.c accel.c adc.c dac.c extint.c i2c.c led.c pin.c rng.c servo.c spi.c uart.c usrsw.c, will generate a HTML structure in gendoc-out/. gendoc.py is crude but functional. Needed something quick, and this was it.