intial commit of tests, documentation

docs/source/conf.py

@@ -0,0 +1,35 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'pyteamsnap'
+copyright = '2022, Anthony Correa'
+author = 'Anthony Correa'
+release = '0.1'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.duration',
+    'sphinx.ext.doctest',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx_rtd_theme',
+]
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+import os; import sys
+sys.path.insert(0, os.path.abspath('../..'))
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_static_path = ['_static']

docs/source/index.rst

@@ -0,0 +1,14 @@
+.. pyteamsnap documentation master file, created by
+   sphinx-quickstart on Sat Nov  5 11:06:19 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+
+.. include:: ../../README.rst
+
+.. toctree::
+  :hidden:
+  :caption: Contents:
+  :maxdepth: 3
+
+  modules

docs/source/modules.rst

@@ -0,0 +1,7 @@
+pyteamsnap
+==========
+
+.. toctree::
+   :maxdepth: 3
+
+   pyteamsnap

docs/source/pyteamsnap.models.rst

@@ -0,0 +1,10 @@
+pyteamsnap.models package
+=========================
+
+Module contents
+---------------
+
+.. automodule:: pyteamsnap.models
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/pyteamsnap.rst

@@ -0,0 +1,29 @@
+pyteamsnap package
+==================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pyteamsnap.models
+
+Submodules
+----------
+
+pyteamsnap.client module
+------------------------
+
+.. automodule:: pyteamsnap.client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pyteamsnap
+   :members:
+   :undoc-members:
+   :show-inheritance: