aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* docs: start using webfontsbnewbold2014-09-013-3/+31
| | | | | For now just point to google-hosted font files, until webfonts get installed at rambutan.cc in a stable location.
* docs: add requirements.txt for readthedocsbnewbold2014-08-281-0/+3
|
* docs: don't look for BREATHE_HOMEbnewbold2014-08-281-1/+2
| | | | | | | As of August 2014, the upstream (system-installed) version should be fine. TODO: update the README file
* 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.
* Remove reST documentation, attendant updates.Marti Bolivar2011-06-11208-16874/+0
| | | | | | | | | | | | | | | | | | | | | | The documentation covers topics not specifically relevant to libmaple, so it doesn't make sense for it to be part of the libmaple source distribution. Delete the docs/ tree, and prepare libmaple for use with the new leaflabs-docs repo, which will contain the docs from now on. * README: update to reflect this change * support/doxygen/Doxyfile: This is the old docs/Doxyfile * Makefile: Add a doxygen target * wirish/comm/HardwareSerial.h: fix reference to docs/. The comment informing maintainers that the HardwareSerial interface is documented by hand refers to the docs/ tree, which no longer exists. Update it to refer to the separate leaflabs-docs repository. * support/scripts/copy-to-ide: No longer build the documentation
* Docs: Add GPIO port pin maps.Marti Bolivar2011-06-103-0/+83
|
* Docs: Update quickstart for Mini.Marti Bolivar2011-06-101-8/+10
|
* Docs: Update "my board is bricked!" troubleshooting item.Marti Bolivar2011-06-101-4/+11
|
* Docs: move ASSERT() to its own page.Marti Bolivar2011-06-105-55/+51
| | | | | ASSERT() was previously documented in language.rst. Move it to a new lang/api/assert.rst.
* Docs: Generalize throb()-related troubleshooting item.Marti Bolivar2011-06-101-8/+6
| | | | | | The FAQ entry which explains the throbbing LED behavior is insufficiently general. Rewrite it so users can tell that throbbing generally indicates a failed assertion or some other error.
* Docs: Use "BOARD_LED_PIN" instead of "13".Marti Bolivar2011-06-108-41/+36
| | | | | | Fix examples where pin 13 was used explicitly instead of BOARD_LED_PIN. Also change an AVR-specific example in docs/lang/cpp/booleanvariables.rst to Maple conventions.
* Docs: add note on adding self to plugdev group.Marti Bolivar2011-06-061-3/+5
| | | | Thanks to forum user AndyH for the suggestion.
* Docs: Correct "Github" -> "GitHub"Marti Bolivar2011-06-033-6/+6
|
* Docs: Various tweaks and fixups.Marti Bolivar2011-06-033-14/+15
| | | | Thanks to forum user AndyH for the corrections.
* Docs: Update release FIXMEs for 0.0.12.Marti Bolivar2011-06-012-9/+6
| | | | | This is a pretty brain-dead way to manage these pre-release preparations. Should figure out the done thing and use that instead.
* Docs: Tweak disabling JTAG debugging information.Marti Bolivar2011-05-282-10/+13
|
* Docs: Simplify and clarify usart.rst.Marti Bolivar2011-05-281-3/+9
| | | | | Make the language a little friendlier, say the words "serial port", and let them know that baud rate is a speed.
* Docs: Improve analogwrite.rst.Marti Bolivar2011-05-281-10/+15
| | | | | | Make the note warning against its usage more direct. Add a blurb introducing its purpose and links in See Also to related board-specific values.
* Docs: Improve i2c.rst.Marti Bolivar2011-05-271-12/+19
| | | | Slightly reorganize to keep it consistent with the rest of the docs.
* Docs: Improve external-interrupts.rst.Marti Bolivar2011-05-271-15/+24
| | | | | Make the language friendlier; point to GPIO port definition for an explanation of the EXTI line definition.
* Docs: Making boards pages point to "5V tolerant" definition.Marti Bolivar2011-05-273-6/+9
|
* Docs: Update gpio.rst.Marti Bolivar2011-05-271-41/+65
| | | | | Add a section about GPIO ports, since that existed nowhere. Made a ref for 5V tolerance. Other clarifications and improvements.
* Docs: Updating pinmode.rstMarti Bolivar2011-05-271-22/+25
| | | | Convert to board-specific values; make the language friendlier.
* Docs: Correct i2c.rst errors.Marti Bolivar2011-05-271-10/+11
| | | | | 10-bit addressing has now been implemented. Slave mode is unimplemented, however.
* Docs: Fix implication that Maple Rev 1 didn't have a battery charger.Marti Bolivar2011-05-271-1/+0
| | | | | It did, but there was no jumper to cut power from the charging circuit, resulting in weird blinky behavior that was fixed in Rev 3.
* Docs: Include D3 in low-noise analog pins on Mini.Marti Bolivar2011-05-271-11/+6
|
* Docs: Fix ADC voltage source error.Marti Bolivar2011-05-272-6/+7
| | | | Vdda, not Vcc.
* Fix millis() example.Marti Bolivar2011-05-261-1/+1
|
* Docs: board-values.rst touchup.Marti Bolivar2011-05-261-3/+0
|
* Make docs say their version is 'custom-build'.Marti Bolivar2011-05-261-1/+2
| | | | | This should get changed on each release branch when the time comes. A FIXME comment has been added to that effect.
* Docs: Move toggleLED() and waitForButtonPress() examples.Marti Bolivar2011-05-263-32/+60
| | | | | These two examples from board-values.rst really belong in the documentation for the functions they reference.
* Docs: Add Maple Mini informationMarti Bolivar2011-05-268-42/+396
| | | | | Flesh out and uncomment maple-mini.rst. Add links to pieces of it in various appropriate places throughout the rest of the documentation.
* Docs: fix and standardize Maple and RET6 hardware pages.Marti Bolivar2011-05-262-266/+372
| | | | | | | | | | Pick a standard layout for the information and fix mistakes. Looks like some of these errors were copy-pasted in from the old HTML documentation, some crept in due to API changes, and some were just wrong. I've checked all the claims against the datasheets and source code, so we should be in good shape now.
* Docs: lang/api/constants.rst touchupsMarti Bolivar2011-05-261-50/+44
| | | | Mostly, make it less pedantic. Also some stylistic and content fixes.
* Docs: troubleshooting.rst touchupsMarti Bolivar2011-05-261-28/+28
|
* Docs: libmaple overview.rst fixes.Marti Bolivar2011-05-261-30/+24
|
* Docs: maple-ret6.rst touchups.Marti Bolivar2011-05-261-2/+4
|
* Generifying maple-ide-install.rst.Marti Bolivar2011-05-231-19/+25
| | | | | | | In line with some changes made earlier today to the maple-ide repo, the master libmaple branch no longer points to a particular IDE release as "current", since there's no way it can know. From now on, only release branches will contain the blessed download links.
* RET6 Edition docs typo.Marti Bolivar2011-05-231-1/+1
|
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-25 11:15:37 +0000