Skip to content

Commit f56d119

Browse files
siddacioussiddacious
committed
kinda need docs
1 parent e4efcca commit f56d119

File tree

6 files changed

+223
-1
lines changed

6 files changed

+223
-1
lines changed

‎.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,4 @@ bundles
99
*.DS_Store
1010
.eggs
1111
dist
12-
docs/
1312
**/*.egg-info

‎docs/_static/favicon.ico

4.31 KB
Binary file not shown.

‎docs/api.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
2+
.. If you created a package, create one automodule per module in the package.
3+
4+
.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
5+
.. use this format as the module name: "adafruit_foo.foo"
6+
7+
.. automodule:: adafruit_tlv493d
8+
:members:

‎docs/conf.py

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
# -*- coding: utf-8 -*-
2+
3+
import os
4+
import sys
5+
sys.path.insert(0, os.path.abspath('..'))
6+
7+
# -- General configuration ------------------------------------------------
8+
9+
# Add any Sphinx extension module names here, as strings. They can be
10+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
11+
# ones.
12+
extensions = [
13+
'sphinx.ext.autodoc',
14+
'sphinx.ext.intersphinx',
15+
'sphinx.ext.napoleon',
16+
'sphinx.ext.todo',
17+
]
18+
19+
# TODO: Please Read!
20+
# Uncomment the below if you use native CircuitPython modules such as
21+
# digitalio, micropython and busio. List the modules you use. Without it, the
22+
# autodoc module docs will fail to generate with a warning.
23+
autodoc_mock_imports = ["adafruit_register", "adafruit_bus_device"]
24+
25+
26+
intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'Register': ('https://circuitpython.readthedocs.io/projects/register/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
27+
28+
# Add any paths that contain templates here, relative to this directory.
29+
templates_path = ['_templates']
30+
31+
source_suffix = '.rst'
32+
33+
# The master toctree document.
34+
master_doc = 'index'
35+
36+
# General information about the project.
37+
project = u'Adafruit TLV493D Library'
38+
copyright = u'2019 Bryan Siepert'
39+
author = u'Bryan Siepert'
40+
41+
# The version info for the project you're documenting, acts as replacement for
42+
# |version| and |release|, also used in various other places throughout the
43+
# built documents.
44+
#
45+
# The short X.Y version.
46+
version = u'1.0'
47+
# The full version, including alpha/beta/rc tags.
48+
release = u'1.0'
49+
50+
# The language for content autogenerated by Sphinx. Refer to documentation
51+
# for a list of supported languages.
52+
#
53+
# This is also used if you do content translation via gettext catalogs.
54+
# Usually you set "language" from the command line for these cases.
55+
language = None
56+
57+
# List of patterns, relative to source directory, that match files and
58+
# directories to ignore when looking for source files.
59+
# This patterns also effect to html_static_path and html_extra_path
60+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md']
61+
62+
# The reST default role (used for this markup: `text`) to use for all
63+
# documents.
64+
#
65+
default_role = "any"
66+
67+
# If true, '()' will be appended to :func: etc. cross-reference text.
68+
#
69+
add_function_parentheses = True
70+
71+
# The name of the Pygments (syntax highlighting) style to use.
72+
pygments_style = 'sphinx'
73+
74+
# If true, `todo` and `todoList` produce output, else they produce nothing.
75+
todo_include_todos = False
76+
77+
# If this is True, todo emits a warning for each TODO entries. The default is False.
78+
todo_emit_warnings = True
79+
80+
napoleon_numpy_docstring = False
81+
82+
# -- Options for HTML output ----------------------------------------------
83+
84+
# The theme to use for HTML and HTML Help pages. See the documentation for
85+
# a list of builtin themes.
86+
#
87+
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
88+
89+
if not on_rtd: # only import and set the theme if we're building docs locally
90+
try:
91+
import sphinx_rtd_theme
92+
html_theme = 'sphinx_rtd_theme'
93+
html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.']
94+
except:
95+
html_theme = 'default'
96+
html_theme_path = ['.']
97+
else:
98+
html_theme_path = ['.']
99+
100+
# Add any paths that contain custom static files (such as style sheets) here,
101+
# relative to this directory. They are copied after the builtin static files,
102+
# so a file named "default.css" will overwrite the builtin "default.css".
103+
html_static_path = ['_static']
104+
105+
# The name of an image file (relative to this directory) to use as a favicon of
106+
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
107+
# pixels large.
108+
#
109+
html_favicon = '_static/favicon.ico'
110+
111+
# Output file base name for HTML help builder.
112+
htmlhelp_basename = 'AdafruitTlv493dLibrarydoc'
113+
114+
# -- Options for LaTeX output ---------------------------------------------
115+
116+
latex_elements = {
117+
# The paper size ('letterpaper' or 'a4paper').
118+
#
119+
# 'papersize': 'letterpaper',
120+
121+
# The font size ('10pt', '11pt' or '12pt').
122+
#
123+
# 'pointsize': '10pt',
124+
125+
# Additional stuff for the LaTeX preamble.
126+
#
127+
# 'preamble': '',
128+
129+
# Latex figure (float) alignment
130+
#
131+
# 'figure_align': 'htbp',
132+
}
133+
134+
# Grouping the document tree into LaTeX files. List of tuples
135+
# (source start file, target name, title,
136+
# author, documentclass [howto, manual, or own class]).
137+
latex_documents = [
138+
(master_doc, 'AdafruitTLV493DLibrary.tex', u'AdafruitTLV493D Library Documentation',
139+
author, 'manual'),
140+
]
141+
142+
# -- Options for manual page output ---------------------------------------
143+
144+
# One entry per manual page. List of tuples
145+
# (source start file, name, description, authors, manual section).
146+
man_pages = [
147+
(master_doc, 'AdafruitTLV493Dlibrary', u'Adafruit TLV493D Library Documentation',
148+
[author], 1)
149+
]
150+
151+
# -- Options for Texinfo output -------------------------------------------
152+
153+
# Grouping the document tree into Texinfo files. List of tuples
154+
# (source start file, target name, title, author,
155+
# dir menu entry, description, category)
156+
texinfo_documents = [
157+
(master_doc, 'AdafruitTLV493DLibrary', u'Adafruit TLV493D Library Documentation',
158+
author, 'AdafruitTLV493DLibrary', 'One line description of project.',
159+
'Miscellaneous'),
160+
]

‎docs/examples.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Simple test
2+
------------
3+
4+
Ensure your device works with this simple test.
5+
6+
.. literalinclude:: ../examples/tlv493d_simpletest.py
7+
:caption: examples/tlv493d_simpletest.py
8+
:linenos:

‎docs/index.rst

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
.. include:: ../README.rst
2+
3+
Table of Contents
4+
=================
5+
6+
.. toctree::
7+
:maxdepth: 4
8+
:hidden:
9+
10+
self
11+
12+
.. toctree::
13+
:caption: Examples
14+
15+
examples
16+
17+
.. toctree::
18+
:caption: API Reference
19+
:maxdepth: 3
20+
21+
api
22+
23+
.. toctree::
24+
:caption: Tutorials
25+
26+
.. toctree::
27+
:caption: Related Products
28+
29+
Adafruit TLV493D Breakout <https://adafruit.com/products>
30+
31+
.. toctree::
32+
:caption: Other Links
33+
34+
Download <https://github.com/adafruit/adafruit_CircuitPython_TLV493D/releases/latest>
35+
CircuitPython Reference Documentation <https://circuitpython.readthedocs.io>
36+
CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>
37+
Discord Chat <https://adafru.it/discord>
38+
Adafruit Learning System <https://learn.adafruit.com>
39+
Adafruit Blog <https://blog.adafruit.com>
40+
Adafruit Store <https://www.adafruit.com>
41+
42+
Indices and tables
43+
==================
44+
45+
* :ref:`genindex`
46+
* :ref:`modindex`
47+
* :ref:`search`

0 commit comments

Comments
 (0)