aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source
diff options
context:
space:
mode:
authorHanna Mendes Levitin <hanna@anomaly-3.(none)>2010-12-02 22:38:45 -0500
committerHanna Mendes Levitin <hanna@anomaly-3.(none)>2010-12-02 22:38:45 -0500
commite5b1e44a8ae8c593456f4b4734f05c9065f6f07b (patch)
treeaaddf79f724a615ca2835746d267a465d8ef33c8 /docs/source
parenta0549b4a15a7093f990fffa4bc1d2d52ec1c16e2 (diff)
downloadlibrambutan-e5b1e44a8ae8c593456f4b4734f05c9065f6f07b.tar.gz
librambutan-e5b1e44a8ae8c593456f4b4734f05c9065f6f07b.zip
side reorder, home link, template mod to add rel bar links
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/_templates/layout.html6
-rw-r--r--docs/source/conf.py4
-rw-r--r--docs/source/home.rst9
-rw-r--r--docs/source/i2c.rst2
-rw-r--r--docs/source/index.rst2
-rw-r--r--docs/source/language-index.rst8
-rw-r--r--docs/source/specs.rst5
7 files changed, 21 insertions, 15 deletions
diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html
new file mode 100644
index 0000000..98b3d82
--- /dev/null
+++ b/docs/source/_templates/layout.html
@@ -0,0 +1,6 @@
+{% extends "!layout.html" %}
+{% block rootrellink %}
+ <li><a href="http://leaflabs.com">LeafLabs</a> |</li>
+ <li><a href="home.html">Docs Home</a> |</li>
+ {{ super() }}
+{% endblock %} \ No newline at end of file
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 755f4ce..1ad4e57 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -143,10 +143,10 @@ html_theme_options = {
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
-html_title = 'LeafLabs' + project + ' v' + release + ' Documentation'
+html_title = project + ' v' + release + ' Documentation'
# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
+html_short_title = 'Index'
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
diff --git a/docs/source/home.rst b/docs/source/home.rst
index 9193e90..db5b56e 100644
--- a/docs/source/home.rst
+++ b/docs/source/home.rst
@@ -7,10 +7,7 @@ Maple Documentation Home
Welcome!
-Maple is a user-friendly prototyping platform developed by LeafLabs in Cambridge, MA. Using Maple, creators with any level of experience can implement beautiful ideas that require the power of a 32-bit processor. For more details about Maple's hardware, please see its :ref:`technical specifications <specs>`. To start using your Maple, keep reading.
-
-.. contents:: Contents
- :local:
+Maple is a user-friendly prototyping platform developed by LeafLabs in Cambridge, MA. Using Maple, creators with any level of experience can implement beautiful ideas that require the power of a 32-bit processor. For more details about Maple's hardware, please see its :ref:`technical specifications <specs>`. To start using your Maple, keep reading
.. _home-Getting-Started:
@@ -19,9 +16,11 @@ Getting Started
:ref:`Quickstart <maple-quickstart>`
+:ref:`IDE Anatomy <ide>`
+
:ref:`Basic Language Reference <language>`
-:ref:`Full Documentation <index>`
+:ref:`Tech Specs<specs>`
.. _home-Problem-Solving:
diff --git a/docs/source/i2c.rst b/docs/source/i2c.rst
index ddb2ac9..6e5b946 100644
--- a/docs/source/i2c.rst
+++ b/docs/source/i2c.rst
@@ -6,7 +6,7 @@
.. note::
- The i2c interface is currently only available from the 'i2c' branch
+ The |i2c| interface is currently only available from the 'i2c' branch
of the github `libmaple <http://github.com/leaflabs/libmaple>`_
repository.
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 9fee4d2..c552dd4 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -34,7 +34,7 @@ Maple Documentation Contents
.. _index-hardware:
-**Hardware Features:**
+**Hardware Peripherals:**
.. toctree::
:maxdepth: 1
diff --git a/docs/source/language-index.rst b/docs/source/language-index.rst
index 1c5e35f..7843cb0 100644
--- a/docs/source/language-index.rst
+++ b/docs/source/language-index.rst
@@ -1,12 +1,12 @@
.. _language-index:
-=============================
-Complete Maple Language Index
-=============================
+=======================
+Complete Language Index
+=======================
This is the index of Maple's :ref:`language reference <language-lang-docs>` documentation. The 'Maple API' column includes language specific to Maple as a microcontroller development platform, while the language in 'C++ for Maple' is more generally applied.
-# Fix above explanation/have marti write it
+# Fix above explanation
.. _index-language-index-cpp:
.. _index-language-index-api:
diff --git a/docs/source/specs.rst b/docs/source/specs.rst
index 43c91a1..4972a83 100644
--- a/docs/source/specs.rst
+++ b/docs/source/specs.rst
@@ -11,8 +11,9 @@ Maple's Technical Specifications
* Operating Voltage: 3.3V
* Input Voltage (recommended): 3.0V-12V
* 39 Digital I/O Pins (:ref:`GPIO <gpio>`)
- * **16 Analog** Input Pins (:ref:`ADC <adc>`)
- * **15 PWM pins** at 16-bit resolution (:ref:`PWM <pwm>`)
+ * 16 Analog Input Pins
+ * 12-bit **ADC** resolution (:ref:`ADC <adc>`)
+ * 15 **PWM** pins at 16-bit resolution (:ref:`PWM <pwm>`)
* Dedicated **USB** port for programming and communications (:ref:`USB<usb>`)
* External **JTAG** interface (:ref:`USB <jtag>`)
* **128 Flash** and **20KB SRAM**