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_Blinka.svg?branch=master
  13     :target: https://travis-ci.org/adafruit/Adafruit_Blinka
  14     :alt: Build Status
  15
  16 This repository contains a selection of packages mirroring the CircuitPython API
  17 on hosts running micropython. Working code exists to emulate the CircuitPython packages;
  18
  19 * **board** - breakout-specific pin identities
  20 * **microcontroller** - chip-specific pin identities
  21 * **digitalio** - digital input/output pins, using pin identities from board+microcontroller packages
  22 * **bitbangio** - software-driven interfaces for I2C, SPI
  23 * **busio** - hardware-driven interfaces for I2C, SPI, UART
  24 * **time** * - substitute functions monkey-patched to time module
  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 The test suites in the test/src folder under **testing.universal** are by design
  35 intended to run on *either* CircuitPython *or* Micropython+compatibility layer to prove conformance.
  36
  37 Usage Example
  38 =============
  39
  40 At the time of writing (`git:7fc1f8ab <https://github.com/cefn/Adafruit_Micropython_Blinka/tree/7fc1f8ab477124628a5afebbf6826005955805f9>`_),
  41 the following sequence runs through some basic testing of the digitalio compatibility layer...
  42
  43 .. code-block:: python
  44
  45     from testing import test_module_name
  46     test_module_name("testing.universal.digitalio")
  47
  48 An example log from running the suites is `here <https://github.com/cefn/Adafruit_Micropython_Blinka/issues/2#issuecomment-366713394>`_ .
  49
  50
  51 Contributing
  52 ============
  53
  54 Contributions are welcome! Please read our `Code of Conduct
  55 <https://github.com/adafruit/Adafruit_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.