From bf5c044b77dd8b0906d4e3d915ae94dd6f2567b6 Mon Sep 17 00:00:00 2001
From: Felix Erdmann <hello@felixerdmann.com>
Date: Wed, 27 Mar 2024 15:33:13 +0000
Subject: [PATCH] add docs

---
 docs/_static/favicon.ico         | Bin 0 -> 4414 bytes
 docs/_static/favicon.ico.license |   3 +
 docs/api.rst                     |   8 ++
 docs/api.rst.license             |   4 +
 docs/conf.py                     | 190 +++++++++++++++++++++++++++++++
 docs/examples.rst                |   8 ++
 docs/examples.rst.license        |   4 +
 docs/index.rst                   |  53 +++++++++
 docs/index.rst.license           |   4 +
 docs/requirements.txt            |   7 ++
 10 files changed, 281 insertions(+)
 create mode 100644 docs/_static/favicon.ico
 create mode 100644 docs/_static/favicon.ico.license
 create mode 100644 docs/api.rst
 create mode 100644 docs/api.rst.license
 create mode 100644 docs/conf.py
 create mode 100644 docs/examples.rst
 create mode 100644 docs/examples.rst.license
 create mode 100644 docs/index.rst
 create mode 100644 docs/index.rst.license
 create mode 100644 docs/requirements.txt

diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico
new file mode 100644
index 0000000000000000000000000000000000000000..5aca98376a1f7e593ebd9cf41a808512c2135635
GIT binary patch
literal 4414
zcmd^BX;4#F6n=SG-XmlONeGrD5E6J{RVh+e928U#MG!$jWvO+UsvWh`x&VqGNx*en
zx=qox7Dqv{kPwo%fZC$dDwVpRtz{HzTkSs8QhG0)%Y=-3@K<l<<eYo%Ip25pcQK3x
ze*XR#{Ku3+4D-S;ObG<IuyH`3e-Mg-fw5M5;xdhtq1wvFCFMAVF9f*3gMj@w2ttJW
zR;Q9>t!4ag|JcIo?$-F|?bXVS9UDUyev>MVZQ(H8K4#;BQW-t2CPorj8^KJrMX}QK
zp+e<;4ldpXz~=)2GxNy811&)gt-}Q*yVQpsxr@VMoA##{)$1~=bZ1MmjeFw?uT(`8
z^g=09<=zW%r%buwN%iHtuKSg|+r7HkT0PYN*_u9k1;^Ss-Z!RBfJ?Un4w(awqp2b3
z%+myoFis_lTlCrGx<dCu7t-9+rxBh;UU30&SA@;~J%BAW6-y3VPQI0H*e<WJX?<&t
zpDCGaRC}9kmEu$Oa}}v(HUDNO$nP=Esno$f#`34=>2z$0BQdh+7?!JK#9K9@Z!VrG
zNj6gK5r(b4?YDOLw|DPRoN7bdP{(>GEG41YcN~4r_SUHU2hgVtUwZG@s%edC;k7Sn
zC)RvEnlq~raE2mY2ko64^m1KQL}3riixh?#J{o)IT+K-RdHae2eRX91-+g!y`8^>#
z-zI0ir>P%Xon)!@xp-BK2bDYUB9k613NRrY6%lVjbFcQc*pR<Snem;7;nfmNCKyIb
zV;aJU1T)2sGslQt)(vOJ>qiK~8xtkNPLxt}e?&QsTB}^!39t_%Qb)~Ukn0O%iC;zt
z<&A-y;3h++)>c1br`5VFM~5(83!HKx$L+my8sW_c#@x*|*vB1yU)_dt3vH;2hqPWx
zAl^6@?ipx&U7pf`a*>Yq6C85nb+B=Fnn+(id$W#WB^uHAcZVG`qg;rWB}ubvi(Y>D
z$ei>REw$#xp0SHAd^|1hq&9HJ=jKK8^zTH~nk)G?yUcmTh9vUM6Y0LMw4(gYVY$D$
zGl&WY&H<)BbJ&3sYbKjx1j^=3-0Q#f^}(aP1?8^`&FUWMp|rmtpK)bLQ1Zo<!81CG
zsjS;turE*y)L_5#=nFEMw(z?yPo#ny)`e!?S}ITO@FMuNfbfy`0m)z$tyIjs2G?*N
zm0s77scmR0&Tia2X6`M7FLCoao*`XmhUYUcEaS*nV(~F>?^s4jqK=Lfg*9&geMGVQ
z#^-*!V`fG@;H&{M9S8%+;|h&Qrxym0Ar>WT4BCVLR8cGXF=JmEYN(sNT(9vl+S|%g
z8r7nXQ(95i^`=+XHo|){$vf2$?=`F$^&wFlYXyXg$B{a>$-Fp+V}+D;9k=~Xl~?C4
zAB-;RKXdUzBJE{V&d&%R>aEfFe;vxqI$0@hwVM}gFeQR@j}a>DDxR+n+-*6|_)k%%
z*mSpDV|=5I9!&VC&9tD%fcVygWZV!iIo2qFtm#!*(s|@ZT33*Ad;+<|3^+yrp*;oH
zBSYLV(H1zTU?2WjrCQoQW)Z>J2a=dTriuvezBmu16`tM2fm7Q@d4^iqII-xFpwHGI
zn<z;!)X&^$x2>9CL}QE*1vdj2PX{PIuqOe5dracsciH6OlAZATvE8rj6ykqdIjal2
z0S0S~PwHb-5?OQ-tU-^KTG@XNrEVSvo|HIP?H;7ZhYeZkhSqh-{reE!5di;1zk$#Y
zCe7rOnlzFYJ6Z#Hm$GoidKB=2HBCwm`BbZVeZY4ukmG%1uz7p2URs6c9j-Gjj^oQV
zsdDb3@k2e`C$1I5ML5U0Qs0C1GAp^?!*`=|Nm(vWz3j*j*8ucum2;r0^-6Aca=Gv)
zc%}&;!+_*S2tlnnJnz0EKeRmw-Y!@9ob!XQBwiv}^u9MkaXHvM=!<3YX;+<jQC-0u
zTIZbaVttaB6kJ{4pU_!C&AAKa__r1E)EgUBa|f(F;*S;tT3qBCkWS#t_EhP}R`~rw
z9NLJ2e~Lzrx8(XwI1ASt`Jsk!0Dv_B#D$8G#km5<s|nBRdqYExwbbm6*U|$TNrH8y
zes7^cDe`NEZz0&`?=IH6K=-gzc&Dl9G`c0gUHr*vMcVa6fm7OTNB7$P{Nem1lhJS%
z`XF~PHRpRb2Klh}^uutU$44XStaq0Or(RmAO#3>2#5Cj5pp?FEK750S3BgeSDtaE^
zXUM@xoV6yBFKfzvY20V&Lr0yC<Oi6z3^xtH5Ih5ptD$TF0Pg}75Ykn!|9k$w9UDH)

literal 0
HcmV?d00001

diff --git a/docs/_static/favicon.ico.license b/docs/_static/favicon.ico.license
new file mode 100644
index 0000000..86a3fbf
--- /dev/null
+++ b/docs/_static/favicon.ico.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries
+
+SPDX-License-Identifier: CC-BY-4.0
diff --git a/docs/api.rst b/docs/api.rst
new file mode 100644
index 0000000..ab22aa5
--- /dev/null
+++ b/docs/api.rst
@@ -0,0 +1,8 @@
+
+.. If you created a package, create one automodule per module in the package.
+
+.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
+.. use this format as the module name: "adafruit_foo.foo"
+
+.. automodule:: hdc1080
+    :members:
diff --git a/docs/api.rst.license b/docs/api.rst.license
new file mode 100644
index 0000000..c230703
--- /dev/null
+++ b/docs/api.rst.license
@@ -0,0 +1,4 @@
+SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+SPDX-FileCopyrightText: Copyright (c) 2024 sensebox
+
+SPDX-License-Identifier: MIT
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..e9e2373
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,190 @@
+# -*- coding: utf-8 -*-
+
+# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+import os
+import sys
+import datetime
+
+sys.path.insert(0, os.path.abspath(".."))
+
+# -- General configuration ------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinxcontrib.jquery",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.todo",
+]
+
+# TODO: Please Read!
+# Uncomment the below if you use native CircuitPython modules such as
+# digitalio, micropython and busio. List the modules you use. Without it, the
+# autodoc module docs will fail to generate with a warning.
+# autodoc_mock_imports = ["digitalio", "busio"]
+
+autodoc_preserve_defaults = True
+
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),"BusDevice": ("https://docs.circuitpython.org/projects/busdevice/en/latest/", None),
+    "Register": ("https://docs.circuitpython.org/projects/register/en/latest/", None),
+    "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None),
+}
+
+# Show the docstring from both the class and its __init__() method.
+autoclass_content = "both"
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
+# General information about the project.
+project = "CircuitPython HDC1080 Library"
+creation_year = "2024"
+current_year = str(datetime.datetime.now().year)
+year_duration = (
+    current_year
+    if current_year == creation_year
+    else creation_year + " - " + current_year
+)
+copyright = year_duration + " sensebox"
+author = "sensebox"
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = "1.0"
+# The full version, including alpha/beta/rc tags.
+release = "1.0"
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# 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",
+    ".env",
+    "CODE_OF_CONDUCT.md",
+]
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#
+default_role = "any"
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#
+add_function_parentheses = True
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# 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
+
+napoleon_numpy_docstring = False
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+import sphinx_rtd_theme
+
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# 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 = "CircuitPython_Hdc1080_Librarydoc"
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (
+        master_doc,
+        "CircuitPython_HDC1080_Library.tex",
+        "CircuitPython HDC1080 Library Documentation",
+        author,
+        "manual",
+    ),
+]
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (
+        master_doc,
+        "CircuitPython_HDC1080_Library",
+        "CircuitPython HDC1080 Library Documentation",
+        [author],
+        1,
+    ),
+]
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        "CircuitPython_HDC1080_Library",
+        "CircuitPython HDC1080 Library Documentation",
+        author,
+        "CircuitPython_HDC1080_Library",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
+]
diff --git a/docs/examples.rst b/docs/examples.rst
new file mode 100644
index 0000000..c3f7fb2
--- /dev/null
+++ b/docs/examples.rst
@@ -0,0 +1,8 @@
+Simple test
+------------
+
+Ensure your device works with this simple test.
+
+.. literalinclude:: ../examples/hdc1080_simpletest.py
+    :caption: examples/hdc1080_simpletest.py
+    :linenos:
diff --git a/docs/examples.rst.license b/docs/examples.rst.license
new file mode 100644
index 0000000..c230703
--- /dev/null
+++ b/docs/examples.rst.license
@@ -0,0 +1,4 @@
+SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+SPDX-FileCopyrightText: Copyright (c) 2024 sensebox
+
+SPDX-License-Identifier: MIT
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..2270855
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,53 @@
+
+.. 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
+
+.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
+    the toctree above for use later.
+
+.. toctree::
+    :caption: Related Products
+
+.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
+    the toctree above for use later.
+
+.. toctree::
+    :caption: Other Links
+
+    Download from GitHub <https://github.com/sensebox/CircuitPython_HDC1080/releases/latest>
+    Download Library Bundle <https://circuitpython.org/libraries>
+    CircuitPython Reference Documentation <https://docs.circuitpython.org>
+    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`
diff --git a/docs/index.rst.license b/docs/index.rst.license
new file mode 100644
index 0000000..c230703
--- /dev/null
+++ b/docs/index.rst.license
@@ -0,0 +1,4 @@
+SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+SPDX-FileCopyrightText: Copyright (c) 2024 sensebox
+
+SPDX-License-Identifier: MIT
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000..979f568
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
+sphinx
+sphinxcontrib-jquery
+sphinx-rtd-theme