| Commit message (Collapse) | Author | Age | Files | Lines |
|
|
|
| |
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
| |
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
| |
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
| |
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
This is a fairly significant set of changes, aimed at improving the
overall usability of the documentation.
Add source/_templates/indexcontent.html, which is a Jinja template
used to generate index.html. This mimics the Python docs' style of
having a short, styled table as main index interface. We're doing
this because people keep missing the board hardware pages that are
below the fold. Hopefully this will make them (and other important
pages) easier to find. The new file source/_static/index-style.css
controls the presentation of the generated index.html.
Move the contents of source/index.rst to source/contents.rst, and
increase the toctree depths to 2. This increase has the ancillary
benefit that secondary headers within the current page are displayed
in the sidebar, which should aid navigation within the page.
contents.rst is meant to be a contents in full, where users who know
what they're looking for can go. The "Table of Contents" link on the
sidebar points here.
Add a new source/_static/leaflabs-docs.css. It's currently unused,
but is the place where people should put CSS that wants to override
the defaults.
Modify source/_templates/layout.html to include aforementioned
leaflabs-docs.css. Also tweak the behavior of the rootrellink block,
which provides the breadcrumbs in page headers and footers.
Change the titles of various top-level docs so they can be referenced
from the toctrees in contents.rst directly. Having two names (one in
the contents, one at the top of the page) has got to be confusing
people. Make an exception for FAQ so that it appears in one line on
the sidebar.
Adjust conf.py to reflect all of these changes. Also:
- Fix "Lucidia" -> "Lucida" typo
- Get rid of intersphinx_mapping (we don't use it, and including
it makes it impossible to build the docs offline).
- Remove the logo from sidebar; it's big and ugly and serves no
purpose.
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Start coloring visited links differently. I have no idea why that was
disabled.
Remove ' Documentation' from the HTML title. It's too long.
Clean up some whitespace.
Remove unused apilist.html and ancillary conf.py.
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
| |
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
| |
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
| |
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
|
|
|
|
| |
Add a void cpp:type:: declaration to build-in-types.rst in order to
silence the voluminous warnings about not knowing what type void is.
Probably we should see if this is in the Sphinx bug tracker.
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Squash from v0.0.12-maintenance:
Power information additions.
Expanded the section "Powering the Maple", added a new "Power Regulation on the Maple" section.
Power info updated for MN and Mini
RET6 power info update
Fixed broken link.
Had wrong link to datasheet for MCP1703.
maple-native-beta: 80-column cosmetic fix
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
| |
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
| |
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
| |
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
|
|
| |
Updates for libmaple commit f3345d6bb096c68bfa59d689daddd14f63a47e30.
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
| |
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
|
|
| |
These are preliminary and should be improved.
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
|
|
| |
Thanks to forum user jumpnowdev.
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
| |
|
|
|
|
| |
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
|
|
|
|
|
|
| |
Improve the "Looking for Something Else" escape hatches, so people who
aren't looking for Wiring can get where they're going more easily.
Fix and improve the Note for C/C++ hackers. Remove the note about
dynamic memory; that works now. Other tweaks.
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Tighten the timeline for updating the images. These are really showing
their age.
Replace all occurrences of "FLASH" in the running text with "Flash".
Replace some usages of "Maple" with "board", to make it clear that the
quickstart applies to all Maple line boards. However, don't replace
all of these. Reinforcing the "Maple" name distinguishes this
quickstart from future ones, e.g. Oak's.
Regarding the LED: fix some of the language around the bootloader
blinks, and point straight to the throb() troubleshooting
item (instead of just the troubleshooting page). Move this paragraph
to after the first program upload; I expect that's when users will be
most curious about the blinking. (Hopefully, these changes will cut
down on support requests about throbbing).
Point at our Twitter account instead of asking for a leaflabs hashtag,
since we actually maintain the Twitter account now.
Other miscellaneous fixups and tweaks.
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
|
|
| |
Remove redundancy in HTML output.
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
|
|
|
| |
Add reference to strtol() to show we're hip to the times. Add link to
arm-gcc section on libc for further reading.
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
| |
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
| |
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
|
|
|
| |
Add note referencing syscalls.c. This gives people a place to start
looking if our newlib stubs don't do what they want.
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
|
|
|
|
|
|
| |
I guess we'll start doing this too, for consistency with what we ask
of our users.
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
|
| |
|
|
|
|
|
| |
This is necessary now that we point to this page from the libmaple
GitHub repo.
|
| |
|
|
|
|
|
|
| |
Add a link to the FAQ; hopefully this will help cut down on support
requests covered by these. Change the language to be a bit less
Maple-centric. Other minor changes.
|
|
|
|
|
| |
As of libmaple v0.0.12, dynamic memory is officially supported. Fix
the FAQ on malloc() etc. not working to reflect this.
|
|
|
|
| |
Until the violence stops.
|
| |
|
|
|
|
| |
Those builds aren't going to happen for 0.0.12. Deal with it.
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
|
|
|
|
| |
Add information on how the documentation is maintained, with specific
notes on the important use cases (adding a new board, versioned docs
build and their maintenance).
|
| |
|
| |
|
| |
|
| |
|
| |
|