Skip to content

Commit 3cdb2e7

Browse files
mrmcwethymrmcwethy
committed
added required new docs folder
1 parent 02aa570 commit 3cdb2e7

File tree

5 files changed

+219
-0
lines changed

5 files changed

+219
-0
lines changed

‎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_ssd1306
8+
:members:

‎docs/conf.py

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

‎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/ssd1306_simpletest.py
7+
:caption: examples/ssd1306_simpletest.py
8+
:linenos:

‎docs/index.rst

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
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+
.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
27+
the toctree above for use later.
28+
29+
.. toctree::
30+
:caption: Related Products
31+
32+
.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
33+
the toctree above for use later.
34+
35+
.. toctree::
36+
:caption: Other Links
37+
38+
Download <https://github.com/adafruit/adafruit_CircuitPython_SSD1306/releases/latest>
39+
CircuitPython Reference Documentation <https://circuitpython.readthedocs.io>
40+
CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>
41+
Discord Chat <https://adafru.it/discord>
42+
Adafruit Learning System <https://learn.adafruit.com>
43+
Adafruit Blog <https://blog.adafruit.com>
44+
Adafruit Store <https://www.adafruit.com>
45+
46+
Indices and tables
47+
==================
48+
49+
* :ref:`genindex`
50+
* :ref:`modindex`
51+
* :ref:`search`

0 commit comments

Comments
 (0)