diff options
| -rw-r--r-- | README | 6 | ||||
| -rw-r--r-- | tmpl/libmaple-proper-page.rst.tmpl | 43 |
2 files changed, 47 insertions, 2 deletions
@@ -107,8 +107,10 @@ It corresponds to the Sphinx file source/index.rst -Read more about Sphinx and chase pointers within the docs source to -find out more. +Read more about Sphinx and use the existing docs source as an example +when writing yours. The directory tmpl/ contains template ReST files +you should modify when creating a new page, in order to keep the style +consistent. The file source/conf.py is the Sphinx configuration file; you can go read it for more information about our setup. diff --git a/tmpl/libmaple-proper-page.rst.tmpl b/tmpl/libmaple-proper-page.rst.tmpl new file mode 100644 index 0000000..c00dd63 --- /dev/null +++ b/tmpl/libmaple-proper-page.rst.tmpl @@ -0,0 +1,43 @@ +.. This page is a template for documenting a peripheral support header +.. in libmaple proper (example: source/libmaple/api/adc.rst). +.. +.. To use, modify "foo" appropriately, etc. If a section would be +.. empty (i.e., there are no devices, just register maps) feel free to +.. leave it out. +.. +.. It would be nice if, in addition to the base breathe directives, +.. you flesh out sections as appropriate with free-form text that +.. helps the user get their job done. + +``foo.h`` +========= + +Support for Furious Oscillation Ocelots (FOO) peripherals. + +.. contents:: Contents + :local: + +Types +----- + +.. Docs for register map and device types here + +Devices +------- + +.. Docs for devices here + +Functions +--------- + +.. Documented, user-facing functions here + +Register Map Base Pointers +-------------------------- + +.. RMBPs here + +Register Bit Definitions +------------------------ + +.. you get the picture |