aboutsummaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* libmaple/api/util.rst: Fixes and tweaks.Marti Bolivar2012-05-161-8/+10
| | | | | | | | | Update title for new libmaple include style. Fix up the bit-manipulation macros; we can't use doxygendefine yet, as its output is missing macro parameter names. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* libmaple/api/bitband.h: Fix title.Marti Bolivar2012-05-161-2/+2
| | | | | | Update for new libmaple include style. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* libmaple/api/ring_buffer.rst: Fix title.Marti Bolivar2012-05-161-2/+2
| | | | | | Update for new libmaple include style. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* libmaple/api/stm32.rst: Updates for new APIs.Marti Bolivar2012-05-161-15/+103
| | | | | | Updates from changes since last release. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* language.rst: Fix capitalization errors.Marti Bolivar2012-05-161-1/+1
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* stm32.rst: Add more flesh.Marti Bolivar2012-05-161-8/+36
| | | | | | | | Change the title so it fits in the sidebar better. Add introductory paragraphs to set the tone for what goes in here. Other additions as needed by imminent changes to other documents. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* libmaple/api/rcc: Add rcc_configure_pll.Marti Bolivar2012-05-161-0/+2
| | | | | | New function. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* libmaple/overview.rst: Fix includes mentioned in comments.Marti Bolivar2012-05-161-4/+4
| | | | | | Update these to the new style. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* libmaple/overview.rst: Improve parallel style.Marti Bolivar2012-05-161-6/+6
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* libmaple/overview.rst: Fix typo.Marti Bolivar2012-05-161-1/+1
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* Rewrite libmaple overview for libmaple series support work.Marti Bolivar2012-05-161-235/+405
| | | | | | | | | libmaple is being ported to other STM32 series than the small set of STM32F103s it supported through v0.0.12. This has caused lots of changes, so that the existing libmaple overview is no longer accurate. Rewrite it to prepare for the next release. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* libmaple/api/stm32: Add STM32_MCU_SERIES.Marti Bolivar2012-05-161-0/+3
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* Add stm32.rst, top-level introduction to STM32.Marti Bolivar2012-05-161-0/+59
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* libmaple/apis.txt: Pick a better title.Marti Bolivar2012-05-161-2/+2
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* libmaple.rst: Tweak languageMarti Bolivar2012-05-161-1/+1
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* contents.rst: Add link to stm32.rstMarti Bolivar2012-05-161-1/+2
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* index: Add link to STM32; cosmetic tweaks.Marti Bolivar2012-05-161-5/+7
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* Tweaks to language.rst for increased series support.Marti Bolivar2012-05-161-23/+15
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* check!Marti Bolivar2012-05-161-3/+10
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* unix-toolchain: Add warnings about our DFU bogosity.Marti Bolivar2012-05-161-0/+10
| | | | | | | | | The bootloader isn't up to spec, and stricter versions of dfu-util don't work with it. There are now some quirks included with dfu-util v0.6 that work around our bugs, so add warnings about the version requirements. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* Redo source/libmaple.rst.Marti Bolivar2012-05-061-21/+26
| | | | | | | This page is not a good introduction. Make edits for clarity and hopefully ease of use. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* libmaple/overview.rst: Clarifications in first paragraph.Marti Bolivar2012-05-061-3/+4
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* libmaple.rst: cosmetic tweak.Marti Bolivar2012-05-061-2/+2
| | | | | | libmaple proper isn't purely C; it contains some assembly, for instance. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* Add FAQ about the command-line toolchain.Marti Bolivar2012-05-061-0/+6
| | | | | | | Sometimes people still ask about this, and the FAQ is a high-profile page, so this seems appropriate. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* faq: Cosmetic tweaks to question styleMarti Bolivar2012-05-061-4/+4
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* index: Use non-breaking space when appropriate.Marti Bolivar2012-05-061-3/+3
| | | | | | | We don't want e.g. "Installing Maple IDE" getting a line-break between "Maple" and "IDE". Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* Split up README into separate files.Marti Bolivar2012-05-063-335/+327
| | | | | | | | The README is pretty long (over 1500 words). Nobody's going to read that. Make it short, and put the long-winded bullshit into other files that are clearly labeled as being for docs maintainers. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* README: tweak sentence about the template filesMarti Bolivar2012-05-061-2/+2
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* README: fix typoMarti Bolivar2012-05-061-1/+1
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* Fix MCU name on Maple Mini hardware page.Marti Bolivar2012-02-101-1/+1
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* Tweak styling of Contents at a Glance.Marti Bolivar2011-10-201-0/+4
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* language-index.rst: Fix outdated information.Marti Bolivar2011-10-081-5/+1
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* Redo appearance of top-level docs and pages.Marti Bolivar2011-10-0811-95/+222
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* configuration: Cleanups and tweaks.Marti Bolivar2011-10-072-12/+3
| | | | | | | | | | | | | 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>
* README: More on how to maintain releases.Marti Bolivar2011-10-071-3/+26
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* libmaple/api/usart: Add usart_rx().Marti Bolivar2011-10-071-0/+1
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* bootloader: Add link to Native bootloader binary.Marti Bolivar2011-10-071-5/+1
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* Hack: silence warnings about 'void'.Marti Bolivar2011-10-051-2/+10
| | | | | | | | 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>
* Add power information to hardware pages.jess b2011-10-054-48/+167
| | | | | | | | | | | | | | | | | | | | 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>
* maple-ide-install: Oracle, not Sun.Marti Bolivar2011-09-261-3/+4
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* unix-toolchain: Add Fedora udev recipe.Marti Bolivar2011-09-261-6/+13
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* libmaple/nvic: Add nvic_sys_reset().Marti Bolivar2011-09-241-0/+1
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* libmaple/scb: Update for fixed SCB.Marti Bolivar2011-09-241-1/+136
| | | | | | Updates for libmaple commit f3345d6bb096c68bfa59d689daddd14f63a47e30. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* unix-toolchain: More Fedora instructions.Marti Bolivar2011-09-241-15/+9
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* unix-toolchain: Add some Fedora instructions.Marti Bolivar2011-09-231-1/+9
| | | | | | These are preliminary and should be improved. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* Fix digitalRead() example bug.Marti Bolivar2011-09-231-1/+1
| | | | | | Thanks to forum user jumpnowdev. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* Added VREF errata.jess b2011-09-171-0/+3
|
* bootloader: Add FIXME for missing Native bootloader link.Marti Bolivar2011-09-212-0/+3
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* language.rst: Improvements for C and C++ programmers.Marti Bolivar2011-09-211-17/+10
| | | | | | | | | | 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>
* maple-quickstart: Updates and improvements.Marti Bolivar2011-09-211-38/+40
| | | | | | | | | | | | | | | | | | | | | | | | | | 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>
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-23 15:18:59 +0000