summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorDan Halbert <halbert@halwitz.org>2018-02-27 22:03:52 -0500
committerGitHub <noreply@github.com>2018-02-27 22:03:52 -0500
commit568c04e6afa8016062f685b2198c0209f62827f4 (patch)
treed07b76119f715add462983b335797adf64b61249 /docs/index.rst
parent6a2379fd0bfe10017d8abc5c36ef1d470c0d9b27 (diff)
parentea633117d01d94e8d56ed94344e4b3e46b4eef03 (diff)
Merge pull request #650 from tannewt/merge_2x3.0.0-alpha.2
Merge in commits from 2.x branch.
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst54
1 files changed, 54 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 000000000..a85772fdc
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,54 @@
+Adafruit CircuitPython API Reference
+====================================
+
+Welcome to the API reference documentation for Adafruit CircuitPython.
+This contains low-level API reference docs which may link out to separate
+*"getting started"* guides. `Adafruit <https://adafruit.com>`_ has many
+excellent tutorials available through the
+`Adafruit Learning System <https://learn.adafruit.com/>`_.
+
+.. include:: ../README.rst
+
+.. _contents:
+
+Full Table of Contents
+----------------------
+
+.. toctree::
+ :maxdepth: 3
+ :caption: API and Usage
+
+ ../shared-bindings/index.rst
+ supported_ports.rst
+ troubleshooting.rst
+ drivers.rst
+
+.. toctree::
+ :maxdepth: 1
+ :caption: Design and porting reference
+
+ design_guide
+ porting
+ common_hal
+
+.. toctree::
+ :maxdepth: 2
+ :caption: MicroPython specific
+
+ library/index.rst
+
+.. toctree::
+ :maxdepth: 1
+ :caption: About the project
+
+ ../README
+ ../CONTRIBUTING
+ ../CODE_OF_CONDUCT
+ ../license.rst
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`