docs: Branch with the V2 documentation #746
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
microbit-carlos
force-pushed
the
v2-docs
branch
2 times, most recently
from
7c0f478 to
70bd815
Compare
microbit-carlos
force-pushed
the
v2-docs
branch
from
cbc668c to
d591517
Compare
microbit-carlos
force-pushed
the
v2-docs
branch
2 times, most recently
from
b47d7e9 to
2a38b7a
Compare
microbit-carlos
force-pushed
the
v2-docs
branch
from
2a38b7a to
92821de
Compare
microbit-carlos
force-pushed
the
v2-docs
branch
from
1c3fc31 to
acee09a
Compare
* Add microphone API * include V2 on index * update music and V2 pins * update speech * update audio * update i2c * add description to built-in sounds * format sounds * format pins * format pins * spelling * Update docs/audio.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * Update docs/audio.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * Update docs/i2c.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * Update docs/microbit_micropython_api.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * Update docs/microbit_micropython_api.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * changes based on initial feedback * update return pin * sound is in microbit module * Update docs/audio.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * Update docs/microbit_micropython_api.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * Update docs/microbit_micropython_api.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * more feedback updates * spacing * Update docs/audio.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * does this comment work? * Revert "does this comment work?" This reverts commit 4846113. * update audio * update audio * add Python Editor * add references to sound * update mic image * Update docs/microbit_micropython_api.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * multiple fixes * use Param in docs * update SouneEvent * update microphone module * update param * update image list * update parameters * remove note * update param * add line break * add mic and make clases a-z * format parameters * Update docs/microbit_micropython_api.rst * Update docs/microbit_micropython_api.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * more updates * tidy up * move SoundEvent * Revert "move SoundEvent" This reverts commit 8f52c97. * move soundEvent * update image list * remove param reference * more feedback updates * move audio to modules * Update docs/music.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * Update docs/microphone.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * Update docs/microbit_micropython_api.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * Update docs/microphone.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * Update docs/music.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * Update docs/audio.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * more updates Co-authored-by: Carlos Pereira Atencio <[email protected]>
* Docs: update for RGBW neopixel * Docs: RGBW neopixels * Update docs/neopixel.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * Update docs/neopixel.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * change to bpp * change to bpp * add image attribution * Update docs/neopixel.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * Add V2 methods * Docs: Update neopixel Co-authored-by: Carlos Pereira Atencio <[email protected]>
* speaker pin changes * Docs: update speaker pin info * Add speaker page * grammar * Link to speaker page * add speaker to navigation * add speaker example * Update docs/speaker.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * Update docs/speaker.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * Update docs/music.rst Co-authored-by: Carlos Pereira Atencio <[email protected]> * Docs: Update speaker pin * remove build * gitignore _build directory * update music * Update docs/music.rst * Update docs/speech.rst * Update docs/speech.rst * Update docs/speech.rst * Update docs/music.rst Co-authored-by: Carlos Pereira Atencio <[email protected]>
* V2 docs: add set_touch_mode() * V2 docs: add set_touch_mode() to micropython API doc
) * Add layout table and partial flashing * deprecated appending script * add build info for v2 * Add section on BLE DFU for V2 * Carlos' feedback * fix filesystem link * fixup! fix filesystem link * fixup! fixup! fix filesystem link * formatting * formatting * fix filesystem link * Update docs/devguide/hexformat.rst Co-authored-by: Carlos Pereira Atencio <[email protected]>
* docs: update-tutorials for V2 * docs: update images * remove pin functions reference link * reduce size of image * Update docs/pin.rst * Update docs/pin.rst * Update docs/tutorials/io.rst Co-authored-by: Carlos Pereira Atencio <[email protected]>
Completes and merges build and flash pages. Adds V2 info. Removes outdated FAQ page. Adds WebUSB info to REPL page. Rebase update: Keeps and updates the flashing paragraph in flashfirmware page.
Includes microbit.run_every function/decorator.
* docs: Add Power Management documentation. * docs: Merge the wake_source() function into deep_sleep(). * docs: Merge power.deep_sleep() `pins` & `buttons` params into `wake_on`. * docs: Move power examples to Python files, and the tech details to the end of the page.
* docs: Add Sound Effects documentation. * docs: Change proposed audio.Effect() to audio.SoundEffect() * docs: Update the proposed default values for audio.SoundEffect(). * docs: Move the SoundEffects constants from `audio` to `audio.SoundEffect`. * docs: Remove SoundEffect `preset` constructor parameter, and add `copy()` method. * docs: Change SoundEffect() `interporlation` parameter to `shape`. * docs: Remove mentions of SoundEffect presets, add ranges, example to file.
* docs: Update Power Mgm to change run_every behaviour. From waking up the board when the next function is scheduled, to allow the scheduled functions to continue running indefinitely while the boards sleeps. * docs: Tweak Power Mgm run_every description & indicate UART wakeup.
…d()`. (#804) * docs: Improve descriptions for microphone module. * docs: Add more info to `microphone.set_threshold()`.
microbit-carlos
force-pushed
the
v2-docs
branch
from
62ea073 to
905577a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This draft PR shows the doc updates for micro:bit V2, which is deployed to ReadTheDocs as the default entry point, which expands to: https://microbit-micropython.readthedocs.io/en/v2-docs/
Many of the changes to the
v2-docsbranch that were not specific to V2 have been backported to the V1 docs, and this branch will be constantly rebased.Having this as opened as PR makes GitHub track the changes between rebases (it adds a timeline entry linking to the old tree), so it can be used for traceability in case some merge/rebase goes wrong.
This PR surseeds #743, which was accidentally opened from a branch in my fork instead of a branch in this repo.