setup docs folder

adafruit · Mar 15, 2018 · f44b26e · f44b26e
1 parent c4ced65
commit f44b26e
Show file tree

Hide file tree

Showing 5 changed files with 81 additions and 4 deletions.
diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico
diff --git a/api.rst → docs/api.rst b/api.rst → docs/api.rst
diff --git a/conf.py → docs/conf.py b/conf.py → docs/conf.py
@@ -2,7 +2,7 @@
 
 import os
 import sys
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('..'))
 
 # -- General configuration ------------------------------------------------
 
@@ -20,15 +20,15 @@
 # autodoc module docs will fail to generate with a warning.
 autodoc_mock_imports = ["micropython", "adafruit_bus_device"]
 
-intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/bus_device/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
+intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 source_suffix = '.rst'
 
 # The master toctree document.
-master_doc = 'README'
+master_doc = 'index'
 
 # General information about the project.
 project = u'Adafruit LSM303 Library'
@@ -54,7 +54,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -71,6 +71,9 @@
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
+# If this is True, todo emits a warning for each TODO entries. The default is False.
+todo_emit_warnings = True
+
 
 # -- Options for HTML output ----------------------------------------------
 
@@ -95,6 +98,12 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+# The name of an image file (relative to this directory) to use as a favicon of
+# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#
+html_favicon = '_static/favicon.ico'
+
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'AdafruitLsm303Librarydoc'
 

diff --git a/docs/examples.rst b/docs/examples.rst
@@ -0,0 +1,20 @@
+Simple tests
+------------
+
+Ensure your device works with these simple tests.
+
+.. literalinclude:: ../examples/fast_accel/fast_accel.py
+    :caption: examples/fast_accel/fast_accel.py
+    :linenos:
+
+.. literalinclude:: ../examples/fast_mag/fast_mag.py
+    :caption: examples/fast_mag/fast_mag.py
+    :linenos:
+
+.. literalinclude:: ../examples/slow_both/slow_both.py
+    :caption: examples/slow_both/slow_both.py
+    :linenos:
+
+.. literalinclude:: ../examples/raw_and_cooked/raw_and_cooked.py
+    :caption: examples/raw_and_cooked/raw_and_cooked.py
+    :linenos:
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,48 @@
+.. include:: ../README.rst
+
+Table of Contents
+=================
+
+.. toctree::
+    :maxdepth: 4
+    :hidden:
+
+    self
+
+.. toctree::
+    :caption: Examples
+
+    examples
+
+.. toctree::
+    :caption: API Reference
+    :maxdepth: 3
+
+    api
+
+.. toctree::
+    :caption: Tutorials
+
+.. toctree::
+    :caption: Related Products
+
+    Triple-axis Accelerometer+Magnetometer (Compass) Board - LSM303 <https://www.adafruit.com/product/1120>
+    FLORA Accelerometer/Compass Sensor - LSM303 - v1.0 <https://www.adafruit.com/product/1247>
+
+.. toctree::
+    :caption: Other Links
+
+    Download <https://github.com/adafruit/Adafruit_CircuitPython_LSM303/releases/latest>
+    CircuitPython Reference Documentation <https://circuitpython.readthedocs.io>
+    CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>
+    Discord Chat <https://adafru.it/discord>
+    Adafruit Learning System <https://learn.adafruit.com>
+    Adafruit Blog <https://blog.adafruit.com>
+    Adafruit Store <https://www.adafruit.com>
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`