From a0549b4a15a7093f990fffa4bc1d2d52ec1c16e2 Mon Sep 17 00:00:00 2001 From: Hanna Mendes Levitin Date: Wed, 1 Dec 2010 03:37:07 -0600 Subject: docs, now with style --- docs/source/specs.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 docs/source/specs.rst (limited to 'docs/source/specs.rst') diff --git a/docs/source/specs.rst b/docs/source/specs.rst new file mode 100644 index 0000000..43c91a1 --- /dev/null +++ b/docs/source/specs.rst @@ -0,0 +1,28 @@ +.. _specs: + +.. _specs-Technical-Specifications: + +================================ +Maple's Technical Specifications +================================ + + * STM32 F103RB: a **32-bit** ARM Cortex M3 microprocessor + * Clock Speed: **72 MHz** + * Operating Voltage: 3.3V + * Input Voltage (recommended): 3.0V-12V + * 39 Digital I/O Pins (:ref:`GPIO `) + * **16 Analog** Input Pins (:ref:`ADC `) + * **15 PWM pins** at 16-bit resolution (:ref:`PWM `) + * Dedicated **USB** port for programming and communications (:ref:`USB`) + * External **JTAG** interface (:ref:`USB `) + * **128 Flash** and **20KB SRAM** + * 64 Channel nested vector interrupt handler (including external interrupt on GPIO’s) + * Integrated **SPI** (:ref:`SPI`) + * Integrated **I2C** (:ref:`I2C`) + * 7 Channels of Direct Memory Access (DMA) + * 3 **USART** divices (:ref:`USART `) + * Four 4-channel Timers (:ref:`Timers `) + * Supplies up to 800mA @ 3.3v + * Support for low power and sleep modes (<500uA) + * Dimensions are 2.05″x2.1″ + -- cgit v1.2.3 From e5b1e44a8ae8c593456f4b4734f05c9065f6f07b Mon Sep 17 00:00:00 2001 From: Hanna Mendes Levitin Date: Thu, 2 Dec 2010 22:38:45 -0500 Subject: side reorder, home link, template mod to add rel bar links --- docs/source/_templates/layout.html | 6 ++++++ docs/source/conf.py | 4 ++-- docs/source/home.rst | 9 ++++----- docs/source/i2c.rst | 2 +- docs/source/index.rst | 2 +- docs/source/language-index.rst | 8 ++++---- docs/source/specs.rst | 5 +++-- 7 files changed, 21 insertions(+), 15 deletions(-) create mode 100644 docs/source/_templates/layout.html (limited to 'docs/source/specs.rst') 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 %} +
  • LeafLabs |
    • +
  • Docs Home |
    • + {{ 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 # " v 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 `. 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 `. To start using your Maple, keep reading .. _home-Getting-Started: @@ -19,9 +16,11 @@ Getting Started :ref:`Quickstart ` +:ref:`IDE Anatomy ` + :ref:`Basic Language Reference ` -:ref:`Full Documentation ` +:ref:`Tech 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 `_ 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 ` 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 `) - * **16 Analog** Input Pins (:ref:`ADC `) - * **15 PWM pins** at 16-bit resolution (:ref:`PWM `) + * 16 Analog Input Pins + * 12-bit **ADC** resolution (:ref:`ADC `) + * 15 **PWM** pins at 16-bit resolution (:ref:`PWM `) * Dedicated **USB** port for programming and communications (:ref:`USB`) * External **JTAG** interface (:ref:`USB `) * **128 Flash** and **20KB SRAM** -- cgit v1.2.3