aboutsummaryrefslogtreecommitdiffstats
path: root/source
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* 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-0810-92/+218
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* 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-211-0/+2
| | | | 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>
* faq: Tweak atoi() entry.Marti Bolivar2011-09-211-3/+3
| | | | | | Remove redundancy in HTML output. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* faq: Improve atoi() FAQ.Marti Bolivar2011-09-211-6/+4
| | | | | | | 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>
* arm-gcc: Improve section :ref: names.Marti Bolivar2011-09-211-1/+5
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* coding-standard: Generify plea for editor configuration help.Marti Bolivar2011-09-211-1/+1
| | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* arm-gcc: Add note about incomplete syscall support.Marti Bolivar2011-09-211-0/+4
| | | | | | | 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>
* contributing.rst: Mention git commit -s.Marti Bolivar2011-09-201-0/+4
| | | | | | | 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>
* contributing.rst: Add link to GitPhraseBook.Marti Bolivar2011-09-201-0/+4
|
* libmaple.rst: Add links to Wirish APIs.Marti Bolivar2011-09-201-1/+3
| | | | | This is necessary now that we point to this page from the libmaple GitHub repo.
* faq: Added another link on fast I/O.Marti Bolivar2011-09-201-1/+3
|
* index: Tweak introductory paragraph.Marti Bolivar2011-09-201-6/+5
| | | | | | 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.
* faq: Fix question on dynamic memory.Marti Bolivar2011-09-201-5/+19
| | | | | As of libmaple v0.0.12, dynamic memory is officially supported. Fix the FAQ on malloc() etc. not working to reflect this.
* fsmc: Half-ass job to get the docs done.Marti Bolivar2011-09-131-8/+27
|
* maple-native-beta: Punt a TODO.Marti Bolivar2011-09-131-2/+0
| | | | Those builds aren't going to happen for 0.0.12. Deal with it.
* gpio: Add ref to Native Beta master pin map.Marti Bolivar2011-09-091-2/+1
|
* index: Add fsmc.rst.Marti Bolivar2011-09-091-0/+1
|
* maple-native-beta: Fix page ref target.Marti Bolivar2011-09-091-1/+1
|
* maple-native-beta: Fix some board-specific values.Marti Bolivar2011-09-091-8/+15
|
* bootloader: Remove Maple-specific values.Marti Bolivar2011-09-091-6/+4
|
* maple-native-beta: Knock out TODO.Marti Bolivar2011-09-091-2/+0
|
* Fixed TODOs in "ADC Pins", "GPIO Info" sectionJessica Barber2011-09-081-14/+17
|
* maple-ret6: Cosmetics.Marti Bolivar2011-09-081-3/+3
|
* hardwarespi: Note about disable JTAG+SW when using SPI3.Marti Bolivar2011-09-081-3/+4
|
* maple-quickstart: Add Native note about charge selection jumper.Marti Bolivar2011-09-081-6/+5
|
* Add links to Native Beta pin maps from peripheral pages.Marti Bolivar2011-09-084-10/+4
|
* conf.py: Add RELEASE milestone.Marti Bolivar2011-09-081-1/+1
|
* detachinterrupt.rst: Comment typo.Marti Bolivar2011-09-081-1/+1
|
* index: Adjust TODO milestone.Marti Bolivar2011-09-081-1/+1
|
* maple-ide-install: Move an "0.0.12" milestone to "RELEASE".Marti Bolivar2011-09-081-1/+1
| | | | | | | We have to do this every time we cut a release branch. The non-numeric milestone RELEASE will now start to be used for any FIXME or TODO that needs doing when the release branch gets cut for a versioned documentation build.
* [libmaple] dma.rst: Cull a finished TODO.Marti Bolivar2011-09-081-2/+0
| | | | This was figured out a while ago.
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-22 23:42:41 +0000