aboutsummaryrefslogtreecommitdiffstats
path: root/docs/tmpl/libmaple-proper-page.rst.tmpl
diff options
context:
space:
mode:
authorbnewbold <bnewbold@robocracy.org>2014-08-27 17:36:11 -0400
committerbnewbold <bnewbold@robocracy.org>2014-08-27 17:42:22 -0400
commit34b766c9d5f778762069938c71e052fa40455d1c (patch)
tree3a2b77e636b222fecff6366218cf7845029afecf /docs/tmpl/libmaple-proper-page.rst.tmpl
parent746d6fecf86572c9fe95dbbffdf541a8d3875dd0 (diff)
parentadd7e54ccaf61859874527feda2b51ea172ce697 (diff)
downloadlibrambutan-34b766c9d5f778762069938c71e052fa40455d1c.tar.gz
librambutan-34b766c9d5f778762069938c71e052fa40455d1c.zip
merge libmaple docs ("leaflabs-docs") into ./docs
In the past, libample documentation was forked out of this repository because the documentation had increased in scope. For the librambutan, and the rambutan project in general, we will try to keep documentation closer to the source code, so the librambutan-specific documentation should live here. Other sections of leaflabs-docs will be culled in a following commit. This merge attempts to maintain history by using a subtree strategy. Followed directions at: http://nuclearsquid.com/writings/subtree-merging-and-you/ Full history for files should be accessible using the "--follow" flag to git log, eg: git log --follow docs/source/adc.rst It should be possible to pull patches from leaflabs-docs with: git pull -s subtree leaflabs-docs master ... at least until the docs in this repository diverge significantly.
Diffstat (limited to 'docs/tmpl/libmaple-proper-page.rst.tmpl')
-rw-r--r--docs/tmpl/libmaple-proper-page.rst.tmpl43
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/tmpl/libmaple-proper-page.rst.tmpl b/docs/tmpl/libmaple-proper-page.rst.tmpl
new file mode 100644
index 0000000..c00dd63
--- /dev/null
+++ b/docs/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