aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/_templates/indexcontent.html13
-rw-r--r--docs/source/bootloader.rst4
-rw-r--r--docs/source/conf.py2
-rw-r--r--docs/source/epilog.rst3
-rw-r--r--docs/source/faq.rst4
-rw-r--r--docs/source/lang/api/hardwarespi.rst3
-rw-r--r--docs/source/lang/cpp/arithmetic.rst2
-rw-r--r--docs/source/libmaple/api/dma.rst10
-rw-r--r--docs/source/libmaple/api/gpio.rst7
-rw-r--r--docs/source/libmaple/api/nvic.rst2
-rw-r--r--docs/source/libmaple/api/util.rst2
-rw-r--r--docs/source/libmaple/overview.rst2
12 files changed, 32 insertions, 22 deletions
diff --git a/docs/source/_templates/indexcontent.html b/docs/source/_templates/indexcontent.html
index d1bb65b..2d1c8f9 100644
--- a/docs/source/_templates/indexcontent.html
+++ b/docs/source/_templates/indexcontent.html
@@ -14,22 +14,23 @@
<!-- Content -->
{% block body %}
-<h1>Hi!</h1>
+<h1>Hi There!</h1>
-This is the documentation for the LeafLabs Maple boards, version {{
-release }}.
+This is the documentation for librambutan, a libre firmware library for STM32
+ARM microcontrollers. If browsing on the docs.rambutan.cc website, you can
+select the version/branch from the box in the lower right-hand corner.
<h2>Read This First</h2>
Having problems? Check
out <a href="{{ pathto("troubleshooting") }}">Troubleshooting</a> and
the <a href="{{ pathto("faq") }}">FAQ</a>. Can't find what you want
-here? Look on the <a href="http://wiki.leaflabs.com/">LeafLabs
-wiki</a>.
+here? Head back up to the <a href="https://docs.rambutan.cc/">project-wide
+docs</a>.
</p>
<p>See the <a href="{{ pathto("whats-new") }}">What's New</a> page for
-changes that are new in {{ release }}.</p>
+changes that are new in '{{ release }}'.</p>
<h2>Contents at a Glance</h2>
diff --git a/docs/source/bootloader.rst b/docs/source/bootloader.rst
index 228207d..bff9bb7 100644
--- a/docs/source/bootloader.rst
+++ b/docs/source/bootloader.rst
@@ -613,8 +613,8 @@ In order to follow these instructions, you will need:
- A binary of the bootloader you want to upload (see below).
- Hardware for communicating between the Maple and your computer over
serial.
-- `Python <http://python.org>`_, version 2.5 or higher.
-- The `PySerial <http://pyserial.sourceforge.net/>`_ library (this
+- Python_, version 2.5 or higher.
+- The PySerial_ library (this
must be installed separately; it is not part of the Python standard
library).
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 50badda..247edbf 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -268,7 +268,7 @@ if os.path.isdir(doxygen_xml_maybe):
doxygen_xml_dir = doxygen_xml_maybe
else:
print("FAIL: doxygen hasn't been run yet in this repository; "
- "see ../README")
+ "see README-building.txt")
sys.exit(-1)
breathe_projects = {'libmaple' : doxygen_xml_dir}
diff --git a/docs/source/epilog.rst b/docs/source/epilog.rst
index 0c1a091..3078639 100644
--- a/docs/source/epilog.rst
+++ b/docs/source/epilog.rst
@@ -12,7 +12,8 @@
.. _Git: http://git-scm.com/
.. _dfu-util: http://wiki.openmoko.org/wiki/Dfu-util
.. _easy_install: http://packages.python.org/distribute/easy_install.html
-.. _Leaflabs Maple: http://leaflabs.com/docs/hardware/maple-mini.html
+.. _Leaflabs Maple: http://leaflabs.com/docs/hardware/maple.html
.. _Leaflabs Maple RET6: http://leaflabs.com/docs/hardware/maple-ret6.html
.. _Leaflabs Maple Mini: http://leaflabs.com/docs/hardware/maple-mini.html
.. _Leaflabs Maple Native Beta: http://leaflabs.com/docs/hardware/maple-native-beta.html
+.. _Maple's master pin map: http://static.leaflabs.com/pub/leaflabs/maple-docs/latest/hardware/maple.html#master-pin-map
diff --git a/docs/source/faq.rst b/docs/source/faq.rst
index bd155ae..b255f52 100644
--- a/docs/source/faq.rst
+++ b/docs/source/faq.rst
@@ -59,8 +59,8 @@ correspond to the pin you want to write to. If you don't know what
that means, don't worry. We'll go through an example here.
Let's say you want to write to pin 4 on the Maple. In order to find
-out the port and bit number, take look at the Maple's :ref:`master pin
-map <maple-pin-map-master>` next to "D4". You'll see that in the
+out the port and bit number, take look at the `Maple's master pin
+map`_ next to "D4". You'll see that in the
"GPIO" column, there's "PB5". That's short for "**P**\ ort **B**, bit
**5**". So the GPIO port is "B", and the bit is "5". (If you're not
on the Maple, you can find your board's pin map :ref:`from here
diff --git a/docs/source/lang/api/hardwarespi.rst b/docs/source/lang/api/hardwarespi.rst
index a44a65f..4d720ac 100644
--- a/docs/source/lang/api/hardwarespi.rst
+++ b/docs/source/lang/api/hardwarespi.rst
@@ -42,7 +42,8 @@ function (an example is given below).
.. FIXME [Breathe] Output doesn't include the class; fix & submit pull req
-.. doxygenfunction:: HardwareSPI::begin
+.. doxygenfunction:: HardwareSPI::begin(void)
+.. doxygenfunction:: HardwareSPI::begin(SPIFrequency, uint32, uint32)
.. note:: If you are using SPI port 3 (on a board that supports it;
not all do); you'll need to call :ref:`lang-disabledebugports`
diff --git a/docs/source/lang/cpp/arithmetic.rst b/docs/source/lang/cpp/arithmetic.rst
index cef3954..b7cb5f6 100644
--- a/docs/source/lang/cpp/arithmetic.rst
+++ b/docs/source/lang/cpp/arithmetic.rst
@@ -110,7 +110,7 @@ types are approximate):
``short``, "0 --- 65,535", "-32,768 --- 32,767", 2
``int``, "0 --- 4,294,967,295", "-2,147,483,648 --- 2,147,483,647", 4
``long``, "0 --- 4,294,967,295", "-2,147,483,648 --- 2,147,483,647", 4
- ``long long``, "0 --- 1.8*10\ :sup:`19`\ " (approx.), "-9.2*10\ :sup:`18` --- 9.2*10\ :sup:`18` (approx.)", 8
+ ``long long``, "0 --- 1.8*10\ :sup:`19`\ (approx.)", "-9.2*10\ :sup:`18` --- 9.2*10\ :sup:`18` (approx.)", 8
See Also
diff --git a/docs/source/libmaple/api/dma.rst b/docs/source/libmaple/api/dma.rst
index 286b6d6..4ce298d 100644
--- a/docs/source/libmaple/api/dma.rst
+++ b/docs/source/libmaple/api/dma.rst
@@ -34,6 +34,10 @@ Devices
Functions
---------
+.. NB: Some of these functions have multiple definitions, in which case the
+ complete function signature needs to be specified to disambiguate or breathe
+ will choke ("Unable to resolve multiple matches for function"...)
+
.. doxygenfunction:: dma_init
.. doxygenfunction:: dma_setup_transfer
.. doxygenfunction:: dma_set_num_transfers
@@ -43,12 +47,12 @@ Functions
.. doxygenfunction:: dma_get_irq_cause
.. doxygenfunction:: dma_enable
.. doxygenfunction:: dma_disable
-.. doxygenfunction:: dma_set_mem_addr
+.. doxygenfunction:: dma_set_mem_addr(dma_dev *, dma_tube, __io void *)
.. doxygenfunction:: dma_set_per_addr
.. doxygendefine:: dma_channel_regs
.. doxygendefine:: dma_is_channel_enabled
-.. doxygenfunction:: dma_get_isr_bits
-.. doxygenfunction:: dma_clear_isr_bits
+.. doxygenfunction:: dma_get_isr_bits(dma_dev *, dma_tube)
+.. doxygenfunction:: dma_clear_isr_bits(dma_dev *, dma_tube)
Register Map Base Pointers
--------------------------
diff --git a/docs/source/libmaple/api/gpio.rst b/docs/source/libmaple/api/gpio.rst
index 9e8e5c7..5f631d5 100644
--- a/docs/source/libmaple/api/gpio.rst
+++ b/docs/source/libmaple/api/gpio.rst
@@ -42,14 +42,17 @@ Functions
.. doxygenfunction:: gpio_init
.. doxygenfunction:: gpio_init_all
-.. doxygenfunction:: gpio_set_mode
+.. doxygenfunction:: gpio_set_mode(gpio_dev *, uint8, gpio_pin_mode)
.. doxygenfunction:: gpio_exti_port
.. doxygenfunction:: gpio_write_bit
.. doxygenfunction:: gpio_read_bit
.. doxygenfunction:: gpio_toggle_bit
.. doxygenfunction:: afio_init
-.. doxygenfunction:: afio_exti_select
+
+.. c:macro:: afio_exti_select(exti, port)
+
+ Macro for `exti_select((exti), (port))`.
.. _gpio-h-afio-remap:
.. doxygenfunction:: afio_remap
diff --git a/docs/source/libmaple/api/nvic.rst b/docs/source/libmaple/api/nvic.rst
index 505e36e..815da2b 100644
--- a/docs/source/libmaple/api/nvic.rst
+++ b/docs/source/libmaple/api/nvic.rst
@@ -49,7 +49,7 @@ Functions
.. doxygenfunction:: nvic_globalirq_disable
.. doxygenfunction:: nvic_irq_enable
.. doxygenfunction:: nvic_irq_disable
-.. doxygenfunction:: nvic_irq_disable_all
+.. doxygenfunction:: nvic_irq_disable_all(void)
.. doxygenfunction:: nvic_sys_reset
Register Maps
diff --git a/docs/source/libmaple/api/util.rst b/docs/source/libmaple/api/util.rst
index 54377c0..2f6e080 100644
--- a/docs/source/libmaple/api/util.rst
+++ b/docs/source/libmaple/api/util.rst
@@ -50,5 +50,5 @@ If an assertion fails, execution is halted at the point of the failed
assertion. When libmaple has been configured properly (Wirish
performs this configuration by default), the built-in LED throbs in a
smooth pattern to signal the failed assertion (using
-:c:func:`throb()`), and the file and line where the assert failed are
+``throb()``), and the file and line where the assert failed are
transmitted to the user as detailed in :ref:`lang-assert`.
diff --git a/docs/source/libmaple/overview.rst b/docs/source/libmaple/overview.rst
index 006f1d8..4f0db1b 100644
--- a/docs/source/libmaple/overview.rst
+++ b/docs/source/libmaple/overview.rst
@@ -467,7 +467,7 @@ do a read-modify-write sequence on the DMA_CCR_PL bits like so::
Of course, before doing that, you should check to make sure there's
not already a device-level function for performing the same task! (In
-this case, there is. It's called :c:func:`dma_set_priority()`; see
+this case, there is. It's called ``dma_set_priority()``; see
:ref:`libmaple-dma`.) For instance, **none of the above code is
portable** to STM32F4, which uses DMA streams instead of channels for
this purpose.