rebuild the html docs

O365 · Nov 3, 2020 · 20f841d · 20f841d
1 parent 798f099
commit 20f841d
Show file tree

Hide file tree

Showing 102 changed files with 59,978 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -13,15 +13,22 @@ Access to Email, Calendar, Contacts, OneDrive, etc. Are easy to do in a way that
 
 The project is currently developed and maintained by [Janscas](https://github.com/janscas). 
 
-Core developers: 
+#### Core developers
 - [Toben Archer](https://github.com/Narcolapser)
-- [Royce Melborn](https://github.com/GeethanadhP)
+- [Geethanadh](https://github.com/GeethanadhP)
 - [Janscas](https://github.com/janscas)
 
-We are always open to new pull requests!
+**We are always open to new pull requests!**
+
+#### Rebuilding HTML Docs
+- Install `shpinx` python library
+
+    `pip install sphinx==2.2.2`
+
+- Run the shell script `build_docs.sh`, or copy the command from the file when using on windows
 
 
-This is for example how you send a message:
+#### Quick example on sending a message:
 
 ```python
 from O365 import Account

diff --git a/build_docs.sh b/build_docs.sh
@@ -0,0 +1 @@
+sphinx-build -b html -c ./docs/source/ ./docs/source/ ./docs/latest/ 
diff --git a/docs/latest/.buildinfo b/docs/latest/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 04549c9572a97ef320d904bfa187d57d
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/latest/.doctrees/api.doctree b/docs/latest/.doctrees/api.doctree
diff --git a/docs/latest/.doctrees/api/account.doctree b/docs/latest/.doctrees/api/account.doctree
diff --git a/docs/latest/.doctrees/api/address_book.doctree b/docs/latest/.doctrees/api/address_book.doctree
diff --git a/docs/latest/.doctrees/api/attachment.doctree b/docs/latest/.doctrees/api/attachment.doctree
diff --git a/docs/latest/.doctrees/api/calendar.doctree b/docs/latest/.doctrees/api/calendar.doctree
diff --git a/docs/latest/.doctrees/api/connection.doctree b/docs/latest/.doctrees/api/connection.doctree
diff --git a/docs/latest/.doctrees/api/drive.doctree b/docs/latest/.doctrees/api/drive.doctree
diff --git a/docs/latest/.doctrees/api/mailbox.doctree b/docs/latest/.doctrees/api/mailbox.doctree
diff --git a/docs/latest/.doctrees/api/message.doctree b/docs/latest/.doctrees/api/message.doctree
diff --git a/docs/latest/.doctrees/api/sharepoint.doctree b/docs/latest/.doctrees/api/sharepoint.doctree
diff --git a/docs/latest/.doctrees/api/utils.doctree b/docs/latest/.doctrees/api/utils.doctree
diff --git a/docs/latest/.doctrees/environment.pickle b/docs/latest/.doctrees/environment.pickle
diff --git a/docs/latest/.doctrees/getting_started.doctree b/docs/latest/.doctrees/getting_started.doctree
diff --git a/docs/latest/.doctrees/index.doctree b/docs/latest/.doctrees/index.doctree
diff --git a/docs/latest/.doctrees/usage.doctree b/docs/latest/.doctrees/usage.doctree
diff --git a/docs/latest/.doctrees/usage/account.doctree b/docs/latest/.doctrees/usage/account.doctree
diff --git a/docs/latest/.doctrees/usage/connection.doctree b/docs/latest/.doctrees/usage/connection.doctree
diff --git a/docs/latest/.doctrees/usage/mailbox.doctree b/docs/latest/.doctrees/usage/mailbox.doctree
diff --git a/docs/latest/.doctrees/usage/query.doctree b/docs/latest/.doctrees/usage/query.doctree
diff --git a/docs/latest/.doctrees/usage/sharepoint.doctree b/docs/latest/.doctrees/usage/sharepoint.doctree
diff --git a/docs/latest/.nojekyll b/docs/latest/.nojekyll
diff --git a/docs/latest/_modules/O365/account.html b/docs/latest/_modules/O365/account.html
diff --git a/docs/latest/_modules/O365/address_book.html b/docs/latest/_modules/O365/address_book.html
diff --git a/docs/latest/_modules/O365/calendar.html b/docs/latest/_modules/O365/calendar.html
diff --git a/docs/latest/_modules/O365/connection.html b/docs/latest/_modules/O365/connection.html
diff --git a/docs/latest/_modules/O365/drive.html b/docs/latest/_modules/O365/drive.html
diff --git a/docs/latest/_modules/O365/mailbox.html b/docs/latest/_modules/O365/mailbox.html
diff --git a/docs/latest/_modules/O365/message.html b/docs/latest/_modules/O365/message.html
diff --git a/docs/latest/_modules/O365/sharepoint.html b/docs/latest/_modules/O365/sharepoint.html
diff --git a/docs/latest/_modules/O365/utils/attachment.html b/docs/latest/_modules/O365/utils/attachment.html
diff --git a/docs/latest/_modules/O365/utils/utils.html b/docs/latest/_modules/O365/utils/utils.html
diff --git a/docs/latest/_modules/index.html b/docs/latest/_modules/index.html
@@ -0,0 +1,205 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <title>Overview: module code &mdash; O365  documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+
+
+  <script src="../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav">
+
+
+  <div class="wy-grid-for-nav">
+
+
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search">
+
+
+
+            <a href="../index.html" class="icon icon-home"> O365
+
+
+
+          </a>
+
+
+
+
+
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+
+        </div>
+
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+              <p class="caption"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../usage.html">Detailed Usage</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../api.html">O365 API</a></li>
+</ul>
+
+
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+      <nav class="wy-nav-top" aria-label="top navigation">
+
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">O365</a>
+
+      </nav>
+
+
+      <div class="wy-nav-content">
+
+        <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+
+      <li><a href="../index.html">Docs</a> &raquo;</li>
+
+      <li>Overview: module code</li>
+
+
+      <li class="wy-breadcrumbs-aside">
+
+      </li>
+
+  </ul>
+
+
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="O365/account.html">O365.account</a></li>
+<li><a href="O365/address_book.html">O365.address_book</a></li>
+<li><a href="O365/calendar.html">O365.calendar</a></li>
+<li><a href="O365/connection.html">O365.connection</a></li>
+<li><a href="O365/drive.html">O365.drive</a></li>
+<li><a href="O365/mailbox.html">O365.mailbox</a></li>
+<li><a href="O365/message.html">O365.message</a></li>
+<li><a href="O365/sharepoint.html">O365.sharepoint</a></li>
+<li><a href="O365/utils/attachment.html">O365.utils.attachment</a></li>
+<li><a href="O365/utils/utils.html">O365.utils.utils</a></li>
+</ul>
+
+           </div>
+
+          </div>
+          <footer>
+
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2018, Narcolapser
+
+    </p>
+  </div>
+  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+
+
+
+
+
+
+      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+        <script src="../_static/jquery.js"></script>
+        <script src="../_static/underscore.js"></script>
+        <script src="../_static/doctools.js"></script>
+        <script src="../_static/language_data.js"></script>
+
+
+
+
+  <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/docs/latest/_sources/api.rst.txt b/docs/latest/_sources/api.rst.txt
@@ -0,0 +1,18 @@
+========
+O365 API
+========
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   api/account
+   api/address_book
+   api/attachment
+   api/calendar
+   api/connection
+   api/drive
+   api/mailbox
+   api/message
+   api/sharepoint
+   api/utils
diff --git a/docs/latest/_sources/api/account.rst.txt b/docs/latest/_sources/api/account.rst.txt
@@ -0,0 +1,7 @@
+Account
+-----------
+
+.. automodule:: O365.account
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/latest/_sources/api/address_book.rst.txt b/docs/latest/_sources/api/address_book.rst.txt
@@ -0,0 +1,7 @@
+Address Book
+------------
+
+.. automodule:: O365.address_book
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/latest/_sources/api/attachment.rst.txt b/docs/latest/_sources/api/attachment.rst.txt
@@ -0,0 +1,7 @@
+Attachment
+----------
+
+.. automodule:: O365.utils.attachment
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/latest/_sources/api/calendar.rst.txt b/docs/latest/_sources/api/calendar.rst.txt
@@ -0,0 +1,7 @@
+Calendar
+--------
+
+.. automodule:: O365.calendar
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/latest/_sources/api/connection.rst.txt b/docs/latest/_sources/api/connection.rst.txt
@@ -0,0 +1,7 @@
+Connection
+----------
+
+.. automodule:: O365.connection
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/latest/_sources/api/drive.rst.txt b/docs/latest/_sources/api/drive.rst.txt
@@ -0,0 +1,7 @@
+One Drive
+---------
+
+.. automodule:: O365.drive
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/latest/_sources/api/mailbox.rst.txt b/docs/latest/_sources/api/mailbox.rst.txt
@@ -0,0 +1,7 @@
+Mailbox
+-------
+
+.. automodule:: O365.mailbox
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/latest/_sources/api/message.rst.txt b/docs/latest/_sources/api/message.rst.txt
@@ -0,0 +1,7 @@
+Message
+-------
+
+.. automodule:: O365.message
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/latest/_sources/api/sharepoint.rst.txt b/docs/latest/_sources/api/sharepoint.rst.txt
@@ -0,0 +1,7 @@
+Sharepoint
+----------
+
+.. automodule:: O365.sharepoint
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/latest/_sources/api/utils.rst.txt b/docs/latest/_sources/api/utils.rst.txt
@@ -0,0 +1,7 @@
+Utils
+-----
+
+.. automodule:: O365.utils.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/latest/_sources/getting_started.rst.txt b/docs/latest/_sources/getting_started.rst.txt
@@ -0,0 +1,39 @@
+###############
+Getting Started
+###############
+
+Installation
+============
+* Stable Version from Pypi
+    https://pypi.org has the latest stable package.
+
+    For installing the package using pip, run :code:`pip install o365`
+
+* Latest Development Version from Github
+    Github has the latest development version, which may have more features but could be unstable.
+    So **Use as own risk**
+
+    For installing code from github, run :code:`pip install git+https://github.com/O365/python-o365.git`
+
+
+OAuth Setup (Pre Requisite)
+===========================
+You will need to register your application at `Microsoft Apps <https://apps.dev.microsoft.com/>`_. Steps below
+
+#. Login to https://apps.dev.microsoft.com/
+#. Create an app, note your app id (**client_id**)
+#. Generate a new password (**client_secret**) under **Application Secrets** section
+#. Under the **Platform** section, add a new Web platform and set "https://outlook.office365.com/owa/" as the redirect URL
+#. Under "Microsoft Graph Permissions" section, Add the below delegated permission (or based on what scopes you plan to use)
+    #. email
+    #. Mail.ReadWrite
+    #. Mail.Send
+    #. User.Read
+
+#. Note the **client_id** and **client_secret** as they will be using for establishing the connection through the api
+
+
+Basic Usage
+===========
+
+Work in progress
diff --git a/docs/latest/_sources/index.rst.txt b/docs/latest/_sources/index.rst.txt
@@ -0,0 +1,17 @@
+Welcome to O365's documentation!
+================================
+
+.. toctree::
+   :maxdepth: 3
+   :caption: Contents:
+
+   getting_started
+   usage
+   api
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`