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 .. todo:: Describe what the library does.
  17
  18 Dependencies
  19 =============
  20 This driver depends on:
  21
  22 * Micropython
  23
  24 Usage Example
  25 =============
  26
  27 .. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
  28
  29 Contributing
  30 ============
  31
  32 Contributions are welcome! Please read our `Code of Conduct
  33 <https://github.com/adafruit/Adafruit_Micropython_Blinka/blob/master/CODE_OF_CONDUCT.md>`_
  34 before contributing to help this project stay welcoming.
  35
  36 Building locally
  37 ================
  38
  39 Sphinx documentation
  40 -----------------------
  41
  42 Sphinx is used to build the documentation based on rST files and comments in the code. First,
  43 install dependencies (feel free to reuse the virtual environment from above):
  44
  45 .. code-block:: shell
  46
  47     python3 -m venv .env
  48     source .env/bin/activate
  49     pip install Sphinx sphinx-rtd-theme
  50
  51 Now, once you have the virtual environment activated:
  52
  53 .. code-block:: shell
  54
  55     cd docs
  56     sphinx-build -E -W -b html . _build/html
  57
  58 This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
  59 view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
  60 locally verify it will pass.