summaryrefslogtreecommitdiff
path: root/shared-bindings/index.rst
diff options
context:
space:
mode:
authorScott Shawcroft <scott@chickadee.tech>2016-10-18 17:42:47 -0700
committerScott Shawcroft <scott@chickadee.tech>2016-10-18 17:42:47 -0700
commit46e7f8e4fb172207121516f5bd15d162aedd041d (patch)
tree7ff3890e7a3339402587f995d3a6c7099194fe61 /shared-bindings/index.rst
parentcb99ae50328de982244ed5cd486ccd57f5bd93bd (diff)
Documentation rework to unify the docs together rather than having them
on a per port basis. Also enables generating docs from inline RST in C code. Simply omits all lines except those that start with //|. Indentation after "//| " will be preserved.
Diffstat (limited to 'shared-bindings/index.rst')
-rw-r--r--shared-bindings/index.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/shared-bindings/index.rst b/shared-bindings/index.rst
new file mode 100644
index 000000000..42394febe
--- /dev/null
+++ b/shared-bindings/index.rst
@@ -0,0 +1,12 @@
+Shared Libraries
+========================================
+
+These core libraries are intended on being consistent across ports. Currently
+they are only implemented in the SAMD21 port but the ESP8266 support will soon
+follow.
+
+.. toctree::
+ :glob:
+ :maxdepth: 3
+
+ modules/*