aboutsummaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* docs: experimental read the docs doxygen supportbnewbold2014-08-281-1/+9
|
* docs: stm32f1/2 namespacing for more variablesbnewbold2014-08-284-9/+21
| | | | | | | There is still a TODO to rework/refactor the entire pages to look prettier, but this keeps breathe from complaining about missing variables (and potentially crashing Sphinx, depending on breathe patch level)
* docs: HACK workaround for 'DAC' doxygen problembnewbold2014-08-281-1/+4
| | | | | | | | | | Tried adding STM32_HAVE_DAC=1 to the PREDEFINED list in support/doxygen/Doxyfile as per mbolivar's suggestion, but the DAC variable still doesn't make it's way into the doxygen output the way ADC1 et al are. So for now we'll just call that variable "undocumented" in the sphinx output and mark it as TODO.
* docs: fix breathe directive types in dma.rstbnewbold2014-08-281-3/+3
|
* docs: add dark solarized pygments style (WIP)bnewbold2014-08-283-2/+73
| | | | | | Really this should be installed as a proper pygments style and selected as such in conf.py. The way this patch works two full .css files get loaded and the second (solarized) clobbers the default.
* docs: give local breath priority over system'sbnewbold2014-08-281-1/+1
| | | | | | If the 'breath' python package (for doxygen => sphinx bridging) is installed system-wide, builds would fail because the system version had priority.
* docs: initial rambutan themebnewbold2014-08-2814-40/+1113
| | | | Still needs bundled fonts and polish.
* docs/source/conf.py: use doxygen XML files from this repobnewbold2014-08-272-11/+9
|
* docs/source/conf.py: initial Maple => Rambutan editsbnewbold2014-08-271-8/+8
|
* docs: first pass removal of board-specific hardware infobnewbold2014-08-2721-2223/+41
|
* docs: first pass removal of Maple IDE infobnewbold2014-08-2722-652/+34
|
* merge libmaple docs ("leaflabs-docs") into ./docsbnewbold2014-08-27231-0/+21803
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In the past, libample documentation was forked out of this repository because the documentation had increased in scope. For the librambutan, and the rambutan project in general, we will try to keep documentation closer to the source code, so the librambutan-specific documentation should live here. Other sections of leaflabs-docs will be culled in a following commit. This merge attempts to maintain history by using a subtree strategy. Followed directions at: http://nuclearsquid.com/writings/subtree-merging-and-you/ Full history for files should be accessible using the "--follow" flag to git log, eg: git log --follow docs/source/adc.rst It should be possible to pull patches from leaflabs-docs with: git pull -s subtree leaflabs-docs master ... at least until the docs in this repository diverge significantly.
| * unix-toolchain: linux: fix ia32-libs instruction for ubuntu 13Marti Bolivar2014-01-151-0/+3
| | | | | | | | | | | | Sigh. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * README-maintainers.txt: add instructions to commit doxygen XMLMarti Bolivar2014-01-151-0/+6
| | | | | | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * conf.py: allow doxygen XML output in repository rootMarti Bolivar2014-01-151-2/+13
| | | | | | | | | | | | | | | | | | | | | | | | It's a pain to have to re-make the XML output for a given release, and there's a chance it'll change between different versions of Doxygen. So look for Doxygen XML output in doxygen/xml/ relative to the repository root. This allows maintenance branches to check in the XML for their version of libmaple. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * fix EXTI line pin mapsbryan newbold2014-01-132-2/+2
| | | | | | | | Thanks to "jappiemike" and "gbulmer" from the forums for finding this.
| * Explicit Windows XP non-supportbryan newbold2013-11-171-9/+11
| | | | | | | | | | | | Also, note that more recent OS X probably works. (fixed cherry-pick conflicts with source/maple-ide-install.rst)
| * fix wikipedia.org broken linkbryan newbold2013-11-171-1/+1
| |
| * fix broken link to usb.org 2.0 specbryan newbold2013-11-171-1/+1
| |
| * Corrected example of blinking an LED with recommended APICameron2013-11-171-2/+2
| |
| * Fixed bad links for pwm.rst, spi.rst, usart.rstCameron2013-11-173-7/+7
| |
| * Fixed broken links in i2c.rstCameron2013-11-171-3/+3
| | | | | | | | I found the correct redirect for the Arduino page, but couldn't find the equivalent ST PDF. I think I found the closest thing but please advise.
| * Fixing broken PDF link on external-interrupts.rstCameron2013-11-171-1/+1
| |
| * Fixing broken links on gpio.rstCameron2013-11-171-2/+2
| |
| * Fixing broken links on usb.rstCameron2013-11-171-3/+3
| |
| * fix broken link on maple native beta pagebryan newbold2013-08-141-1/+1
| |
| * note about XCode cost (thanks Wes Peters)bryan newbold2013-08-141-6/+5
| |
| * add dummy breathe.css to prevent 404sbryan newbold2013-02-211-0/+1
| | | | | | | | Signed-off-by: bryan newbold <bnewbold@leaflabs.com>
| * jtag-wiring.png is maple-jtagadapter.pngbnewbold2013-02-131-2/+2
| | | | | | | | | | There was a link to a "full size" version of an image, but it's actually the exact same file bundled with the docs.
| * unix-toolchain-linux-setup: Fix up udev on Debian.Marti Bolivar2012-09-051-3/+15
| | | | | | | | | | | | | | | | Thanks to bnewbold: http://forums.leaflabs.com/topic.php?id=1884 Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * unix-toolchain: Fix up JTAG section.Marti Bolivar2012-09-051-7/+13
| | | | | | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * unix-toolchain: Fix up Windows so-far-so-good section.Marti Bolivar2012-09-051-6/+7
| | | | | | | | | | | | Oops. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * unix-toolchain: Link back to main setup from individual setup pages.Marti Bolivar2012-09-054-3/+10
| | | | | | | | | | | | These help if someone was accidentally linked to the wrong page. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * unix-toolchain: Break individual OS setup docs into separate files.Marti Bolivar2012-09-056-479/+524
| | | | | | | | | | | | | | | | A monolithic quickstart is too unwieldy at this point. Move the initial setup instructions into their own files to make it less daunting and easier to read. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * unix-toolchain: Tweak requirements section.Marti Bolivar2012-09-051-11/+14
| | | | | | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * unix-toolchain: Windows instructions, for real this time.Marti Bolivar2012-09-058-115/+244
| | | | | | | | | | | | | | | | | | Forget using Git Bash. Use GitHub for Windows instead. Thanks, GitHub. Windows quirks need to propagate into a variety of other sections, which implies some minor restructuring. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * unix-toolchain: Update "tested on" for OS X.Marti Bolivar2012-09-051-1/+2
| | | | | | | | | | | | | | The FormLabs crew reports that the directions are still good on Mountain Lion. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * unix-toolchain: add Python link at bottom of page.Marti Bolivar2012-09-054-5/+6
| | | | | | | | | | | | We'll need this in a couple of other places. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * unix-toolchain: Add links for easy_install.Marti Bolivar2012-09-051-3/+3
| | | | | | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * unix-toolchain: Fix up Debian udev rules instructions.Marti Bolivar2012-09-051-2/+7
| | | | | | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * Fix typos in board power regulation sections.Marti Bolivar2012-09-033-13/+13
| | | | | | | | | | | | "amount off current" is wrong. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * Update <libmaple/scb.h> page.Marti Bolivar2012-07-131-143/+134
| | | | | | | | | | | | | | | | | | No resolution on the necessary F2 changes, so that's a TODO. Otherwise, the changes are purely stylistic or made for increasing clarity; the API itself hasn't changed. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * whats-new: minor tweaksMarti Bolivar2012-07-131-3/+3
| | | | | | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * Mention Windows unix-toolchain instructions in whats-new.rst.Marti Bolivar2012-07-131-0/+3
| | | | | | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * Finish redoing the Unix toolchain.Marti Bolivar2012-07-131-200/+280
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | General: - Beef up "Start your own project" section, mention the example libmaple project page on the wiki. - Tune the "Get updates" page to encourage people to run libmaple master. - Fix the stupid JTAG section to acknowledge the fact that we don't officially support it. Mention the JTAG how-to on the wiki. Linux: - Better visual distinction for which instructions belong to which distributions. - Fixed instructions for 64-bit distributions. - Clean up libmaple/arm-none-eabi-* instructions and udev rules. OS X: - Minor language tweaks. Windows: - Mention (new at time of writing) libmaple script support/scripts/win-list-com-ports.py, which lists available serial ports. - Audit other sections for missing Windows-specific instructions, and add them. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * Merge remote-tracking branch 'refs/remotes/origin/unix-toolchain-overhaul'Marti Bolivar2012-07-095-146/+251
| |\ | | | | | | | | | | | | | | | | | | | | | | | | | | | This adds some initial Windows notes. Conflicts were related to the dfu-util warnings. Conflicts: source/unix-toolchain.rst Signed-off-by: Marti Bolivar <mbolivar@lozenge.(none)>
| | * [WIP] Overhaul Unix toolchain quickstart.Marti Bolivar2011-10-045-143/+246
| | | | | | | | | | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * | Add initial whats-new.rst.Marti Bolivar2012-06-293-0/+82
| | | | | | | | | | | | | | | | | | | | | It needs a lot more work before being done, obviously. Refer to it prominently from the index page, and add it to the contents tree. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * | (Mostly) update <libmaple/adc.h> page.Marti Bolivar2012-06-291-172/+188
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Still undone: - resolve Breathe/Doxygen/whatever bug that keeps adc_config_gpio() docs from showing up - add register bit definitions Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
| * | libraries.rst: update FIXME since crenn's Wire mergedMarti Bolivar2012-06-291-1/+1
| | | | | | | | | | | | Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>