README.rst

   1 Introduction
   2 ============
   3
   4 .. image:: https://readthedocs.org/projects/adafruit-micropython-blinka/badge/?version=latest
   5     :target: https://circuitpython.readthedocs.io/projects/blinka/en/latest/
   6     :alt: Documentation Status
   7
   8 .. image:: https://img.shields.io/discord/327254708534116352.svg
   9     :target: https://discord.gg/nBQh6qu
  10     :alt: Discord
  11
  12 .. image:: https://travis-ci.org/adafruit/Adafruit_Micropython_Blinka.svg?branch=master
  13     :target: https://travis-ci.org/adafruit/Adafruit__Micropython_Blinka
  14     :alt: Build Status
  15
  16 Description
  17 ===========
  18
  19 This repository contains a selection of packages mirroring the CircuitPython API
  20 on hosts running micropython. At the time of writing drafts exist for
  21
  22 * board - breakout-specific pin identities
  23 * microcontroller - chip-specific pin identities
  24 * digitalio - digital input/output pins, using pin identities from board/microcontroller
  25
  26
  27 Dependencies
  28 =============
  29
  30 The Micropython compatibility layers described above are intended to provide a CircuitPython-like API for devices which
  31 are running Micropython. Since corresponding packages should be built-in to any standard
  32 CircuitPython image, they have no value on a device already running CircuitPython and would likely conflict in unhappy ways.
  33
  34 However, the test suites under *testing.implementation.all* are by design
  35 intended to run on either CircuitPython or on Micropython+compatibility layer to prove conformance, while the test suites under *testing.implementation.micropython* will only run
  36 on Micropython and *testing.implementation.circuitpython* will only run on CircuitPython
  37
  38
  39 Usage Example
  40 =============
  41
  42 At the time of writing (`git:3b2fc268 <https://github.com/cefn/Adafruit_Micropython_Blinka/tree/3b2fc268d89aee6a648da456224e6d48d2476baa>`_),
  43 the following sequence runs through some basic testing of the digitalio compatibility layer.
  44
  45 .. code-block:: python
  46
  47     import testing
  48     testing.main()
  49
  50
  51 Contributing
  52 ============
  53
  54 Contributions are welcome! Please read our `Code of Conduct
  55 <https://github.com/adafruit/Adafruit_Micropython_Blinka/blob/master/CODE_OF_CONDUCT.md>`_
  56 before contributing to help this project stay welcoming.
  57
  58 Building locally
  59 ================
  60
  61 Sphinx documentation
  62 -----------------------
  63
  64 Sphinx is used to build the documentation based on rST files and comments in the code. First,
  65 install dependencies (feel free to reuse the virtual environment from above):
  66
  67 .. code-block:: shell
  68
  69     python3 -m venv .env
  70     source .env/bin/activate
  71     pip install Sphinx sphinx-rtd-theme
  72
  73 Now, once you have the virtual environment activated:
  74
  75 .. code-block:: shell
  76
  77     cd docs
  78     sphinx-build -E -W -b html . _build/html
  79
  80 This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
  81 view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
  82 locally verify it will pass.