FPriv · kirit93 · Apr 12, 2019
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/_build/doctrees/api.doctree b/docs/_build/doctrees/api.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/introduction.doctree b/docs/_build/doctrees/introduction.doctree
diff --git a/docs/_build/doctrees/sdk.doctree b/docs/_build/doctrees/sdk.doctree
diff --git a/docs/_build/doctrees/source/factom_sdk.client.doctree b/docs/_build/doctrees/source/factom_sdk.client.doctree
diff --git a/docs/_build/doctrees/source/factom_sdk.doctree b/docs/_build/doctrees/source/factom_sdk.doctree
diff --git a/docs/_build/doctrees/source/factom_sdk.request_handler.doctree b/docs/_build/doctrees/source/factom_sdk.request_handler.doctree
diff --git a/docs/_build/doctrees/source/factom_sdk.utils.doctree b/docs/_build/doctrees/source/factom_sdk.utils.doctree
diff --git a/docs/_build/doctrees/source/factom_sdk.utils.identities.doctree b/docs/_build/doctrees/source/factom_sdk.utils.identities.doctree
diff --git a/docs/_build/doctrees/source/modules.doctree b/docs/_build/doctrees/source/modules.doctree
diff --git a/docs/_build/doctrees/starting.doctree b/docs/_build/doctrees/starting.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.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: 33b2a0294c6f4c3802e2b2b2c5459b5c
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_images/architecture.jpg b/docs/_build/html/_images/architecture.jpg
diff --git a/docs/_build/html/_sources/api.rst.txt b/docs/_build/html/_sources/api.rst.txt
@@ -0,0 +1,48 @@
+API
+====
+
+.. contents::
+    Clients
+
+Clients
+--------
+
+API Client
+-------------
+
+.. automodule:: factom_sdk.client.api_info_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Chain Client
+---------------
+
+.. automodule:: factom_sdk.client.chains_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Entries Client
+----------------
+
+.. automodule:: factom_sdk.client.entries_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Factom Client
+---------------
+
+.. automodule:: factom_sdk.client.factom_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Identities Client
+-------------------
+
+.. automodule:: factom_sdk.client.identities_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -0,0 +1,22 @@
+.. factom documentation master file, created by
+   sphinx-quickstart on Tue Apr  9 17:47:03 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to factom's documentation!
+==================================
+
+.. toctree::
+   :maxdepth: 3
+
+   introduction
+   starting
+   sdk
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/_build/html/_sources/introduction.rst.txt b/docs/_build/html/_sources/introduction.rst.txt
@@ -0,0 +1,27 @@
+Introduction
+================
+
+.. contents::
+    About
+    SDK Architecture Overview
+
+
+.. Note:: This is sample documentation.
+
+About
+--------
+This documentation is written for developers with a basic level of coding knowledge and familiarity of the Python programming language.
+Readers can find guidelines to quickly get started with building and using the Python SDK for Factom Harmony Connect.
+You can learn more about Factom Harmony Connect `here <https://docs.harmony.factom.com/>`_.
+This SDK is open source and can be accessed on Github `here <https://github.com/FactomProject/factom-harmony-connect-python-sdk>`_.
+
+
+SDK Architecture Overview
+---------------------------
+.. image:: _static/architecture.jpg
+
+| **FactomSDK Class**: Manages SDK constructor, product connection and provides access to other layers.
+| **Utilities**: Contain functions shared between core components.
+| **Core**: Contains main components that interact with Connect API.
+| **Request/Response Handler**: Handles all requests/responses (HTTP / HTTPS) from Connect API before passing them to other components.
+
diff --git a/docs/_build/html/_sources/sdk.rst.txt b/docs/_build/html/_sources/sdk.rst.txt
@@ -0,0 +1,41 @@
+SDK Contents
+=============
+
+.. contents::
+    Identities
+    Chains
+    Entries
+
+Identities
+------------
+
+Identities Client
+~~~~~~~~~~~~
+.. automodule:: factom_sdk.client.identities_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Key Client
+~~~~~~~~~~~~
+.. automodule:: factom_sdk.utils.identities.identities_key_util
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Chains
+------------
+
+.. automodule:: factom_sdk.client.chains_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Entries
+------------
+
+.. automodule:: factom_sdk.client.entries_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/_build/html/_sources/source/factom_sdk.client.rst.txt b/docs/_build/html/_sources/source/factom_sdk.client.rst.txt
@@ -0,0 +1,54 @@
+factom\_sdk.client package
+==========================
+
+Submodules
+----------
+
+factom\_sdk.client.api\_info\_client module
+-------------------------------------------
+
+.. automodule:: factom_sdk.client.api_info_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+factom\_sdk.client.chains\_client module
+----------------------------------------
+
+.. automodule:: factom_sdk.client.chains_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+factom\_sdk.client.entries\_client module
+-----------------------------------------
+
+.. automodule:: factom_sdk.client.entries_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+factom\_sdk.client.factom\_client module
+----------------------------------------
+
+.. automodule:: factom_sdk.client.factom_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+factom\_sdk.client.identities\_client module
+--------------------------------------------
+
+.. automodule:: factom_sdk.client.identities_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: factom_sdk.client
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/_build/html/_sources/source/factom_sdk.request_handler.rst.txt b/docs/_build/html/_sources/source/factom_sdk.request_handler.rst.txt
@@ -0,0 +1,22 @@
+factom\_sdk.request\_handler package
+====================================
+
+Submodules
+----------
+
+factom\_sdk.request\_handler.request\_handler module
+----------------------------------------------------
+
+.. automodule:: factom_sdk.request_handler.request_handler
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: factom_sdk.request_handler
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/_build/html/_sources/source/factom_sdk.rst.txt b/docs/_build/html/_sources/source/factom_sdk.rst.txt
@@ -0,0 +1,19 @@
+factom\_sdk package
+===================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    factom_sdk.client
+    factom_sdk.request_handler
+    factom_sdk.utils
+
+Module contents
+---------------
+
+.. automodule:: factom_sdk
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/_build/html/_sources/source/factom_sdk.utils.identities.rst.txt b/docs/_build/html/_sources/source/factom_sdk.utils.identities.rst.txt
@@ -0,0 +1,22 @@
+factom\_sdk.utils.identities package
+====================================
+
+Submodules
+----------
+
+factom\_sdk.utils.identities.identities\_key\_util module
+---------------------------------------------------------
+
+.. automodule:: factom_sdk.utils.identities.identities_key_util
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: factom_sdk.utils.identities
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/_build/html/_sources/source/factom_sdk.utils.rst.txt b/docs/_build/html/_sources/source/factom_sdk.utils.rst.txt
@@ -0,0 +1,61 @@
+factom\_sdk.utils package
+=========================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    factom_sdk.utils.identities
+
+Submodules
+----------
+
+factom\_sdk.utils.common\_util module
+-------------------------------------
+
+.. automodule:: factom_sdk.utils.common_util
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+factom\_sdk.utils.consts module
+-------------------------------
+
+.. automodule:: factom_sdk.utils.consts
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+factom\_sdk.utils.key\_common module
+------------------------------------
+
+.. automodule:: factom_sdk.utils.key_common
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+factom\_sdk.utils.utils module
+------------------------------
+
+.. automodule:: factom_sdk.utils.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+factom\_sdk.utils.validate\_signature\_util module
+--------------------------------------------------
+
+.. automodule:: factom_sdk.utils.validate_signature_util
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: factom_sdk.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/_build/html/_sources/source/modules.rst.txt b/docs/_build/html/_sources/source/modules.rst.txt
@@ -0,0 +1,7 @@
+factom_sdk
+==========
+
+.. toctree::
+   :maxdepth: 4
+
+   factom_sdk
diff --git a/docs/_build/html/_sources/starting.rst.txt b/docs/_build/html/_sources/starting.rst.txt
@@ -0,0 +1,30 @@
+Getting Started
+================
+
+.. contents::
+    System Requirements
+    Installation
+
+
+This section contains a summary of the steps required to get started with Python Connect SDK installation.
+
+.. Note:: This is sample documentation.
+
+System Requirements
+---------------------
+In order to use this Python SDK, you will need the following tool:
+| Python version >= 3.5
+
+Installation
+--------------
+*Published package*
+
+| ``pip install factom-harmony-connect``
+
+*Open-source package*
+
+* Clone the repo
+* Setup a virtual environment (optional)
+* Install dependencies
+* pip install -r requirements.txt``
+* To use the SDK, you have to import: from factom_sdk import FactomClient
diff --git a/docs/_build/html/_static/architecture.jpg b/docs/_build/html/_static/architecture.jpg