setup docs folder

This commit is contained in:
sommersoft 2018-03-01 20:41:57 -06:00
parent 804a973afb
commit 48f1772d5d
5 changed files with 71 additions and 3 deletions

BIN
docs/_static/favicon.ico vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB

View File

@ -2,7 +2,7 @@
import os import os
import sys import sys
sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('..'))
# -- General configuration ------------------------------------------------ # -- General configuration ------------------------------------------------
@ -29,7 +29,7 @@ templates_path = ['_templates']
source_suffix = '.rst' source_suffix = '.rst'
# The master toctree document. # The master toctree document.
master_doc = 'README' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'Adafruit MAX31865 Library' project = u'Adafruit MAX31865 Library'
@ -55,7 +55,7 @@ language = None
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path # 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 # The reST default role (used for this markup: `text`) to use for all
# documents. # documents.
@ -72,6 +72,9 @@ pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing. # If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False 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 ---------------------------------------------- # -- Options for HTML output ----------------------------------------------
@ -96,6 +99,12 @@ else:
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] 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. # Output file base name for HTML help builder.
htmlhelp_basename = 'AdafruitMAX31865Librarydoc' htmlhelp_basename = 'AdafruitMAX31865Librarydoc'

8
docs/examples.rst Normal file
View File

@ -0,0 +1,8 @@
Simple test
------------
Ensure your device works with this simple test.
.. literalinclude:: ../examples/max31865_simpletest.py
:caption: examples/max31865_simpletest.py
:linenos:

51
docs/index.rst Normal file
View File

@ -0,0 +1,51 @@
.. 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
Adafruit Universal Thermocouple Amplifier MAX31856 Breakout <https://www.adafruit.com/product/3263>
Adafruit PT100 RTD Temperature Sensor Amplifier - MAX31865 <https://www.adafruit.com/product/3328>
Adafruit PT1000 RTD Temperature Sensor Amplifier - MAX31865 <https://www.adafruit.com/product/3648>
.. toctree::
:caption: Other Links
Download <https://github.com/adafruit/Adafruit_CircuitPython_MAX31865/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`