Merge pull request #39 from dexhunter/docs-deployment

build docs gitpages
hyperledger · Mar 24, 2020 · f33e056 · f33e056
2 parents 57c4044 + 87389c6
commit f33e056
Show file tree

Hide file tree

Showing 90 changed files with 19,524 additions and 142 deletions.
diff --git a/.gitignore b/.gitignore
@@ -11,7 +11,7 @@ __pycache__/
 # Distribution / packaging
 .Python
 env/
-build/
+# build/
 develop-eggs/
 dist/
 downloads/

diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ More details to build the crypto lib, can be found at [Install Python Cryotograp
 
 ## Tutorial
 
-Read the [Tutorial](docs/tutorial.md) to get familiar with the APIs.
+Read the [Tutorial](https://fabric-sdk-py.readthedocs.io/tutorial.html) ([Source](docs/source/tutorial.md)) to get familiar with the APIs.
 
 ## Quick Testing
 

diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,21 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+SPHINXPROJ    = fabric-sdk-py
+
+# 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/README.md b/docs/README.md
@@ -0,0 +1,11 @@
+Documentation for `fabric-sdk-py` package.
+
+Prerequisuites:
+
+```bash
+$ pip install sphinx
+$ pip install sphinx_rtd_theme
+
+$ make html
+```
+
diff --git a/docs/build/doctrees/CONTRIBUTING.doctree b/docs/build/doctrees/CONTRIBUTING.doctree
diff --git a/docs/build/doctrees/code_style.doctree b/docs/build/doctrees/code_style.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/release_note.doctree b/docs/build/doctrees/release_note.doctree
diff --git a/docs/build/doctrees/tutorial.doctree b/docs/build/doctrees/tutorial.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: ff19f96901c974f1808337ae7a870ed4
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/CONTRIBUTING.html b/docs/build/html/CONTRIBUTING.html
@@ -0,0 +1,248 @@
+
+
+<!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>&lt;no title&gt; &mdash; fabric-sdk-py  documentation</title>
+
+
+
+
+
+
+
+
+  <script type="text/javascript" src="_static/js/modernizr.min.js"></script>
+
+
+      <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>
+
+
+
+
+  <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" />
+    <link rel="prev" title="Python Coding Style" href="code_style.html" /> 
+</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"> fabric-sdk-py
+
+
+
+          </a>
+
+
+
+
+              <div class="version">
+                0.9.0
+              </div>
+
+
+
+
+<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">
+
+
+
+
+
+
+              <ul>
+<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="tutorial.html#prepare-a-testing-environment">0. Prepare a Testing Environment</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="tutorial.html#install-fabric-sdk">0.1. Install Fabric SDK</a></li>
+<li class="toctree-l3"><a class="reference internal" href="tutorial.html#setup-a-fabric-network">0.2. Setup a Fabric Network</a></li>
+<li class="toctree-l3"><a class="reference internal" href="tutorial.html#create-the-connection-profile">0.3. Create the Connection Profile</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="tutorial.html#get-credentials">1. Get Credentials</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="tutorial.html#load-the-connection-profile">1.1 Load the Connection Profile</a></li>
+<li class="toctree-l3"><a class="reference internal" href="tutorial.html#prepare-user-id-optionally">1.2 Prepare User Id (Optionally)</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="tutorial.html#using-local-credential">1.2.1 Using Local Credential</a></li>
+<li class="toctree-l4"><a class="reference internal" href="tutorial.html#get-credentail-from-fabric-ca">1.2.2 Get Credentail from Fabric CA</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="tutorial.html#operate-channels-with-fabric-network">2. Operate Channels with Fabric Network</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="tutorial.html#create-a-new-channel-and-join-it">2.1 Create a new channel and join it</a></li>
+<li class="toctree-l3"><a class="reference internal" href="tutorial.html#update-the-channel-configuration">2.2 Update the Channel Configuration</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="tutorial.html#operate-chaincodes-with-fabric-network">3. Operate Chaincodes with Fabric Network</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorial.html#query-informations">4. Query Informations</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="tutorial.html#basic-usage">4.1 Basic Usage</a></li>
+<li class="toctree-l3"><a class="reference internal" href="tutorial.html#query-block-by-block-hash-transaction-id">4.2 Query Block by block hash &amp; transaction id</a></li>
+<li class="toctree-l3"><a class="reference internal" href="tutorial.html#query-block-transaction-and-instantiated-chaincodes">4.3 Query Block, Transaction and Instantiated Chaincodes</a></li>
+<li class="toctree-l3"><a class="reference internal" href="tutorial.html#get-channel-configuration">4.4 Get channel configuration</a></li>
+<li class="toctree-l3"><a class="reference internal" href="tutorial.html#use-channel-discovery">4.5 Use channel discovery</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="tutorial.html#license-a-name-license-a">License <a name="license"></a></a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="release_note.html">Release Note</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="release_note.html#v0-8-0-apr-12-2019">v0.8.0 Apr 12, 2019</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="release_note.html#add-new-features">Add new features</a></li>
+<li class="toctree-l3"><a class="reference internal" href="release_note.html#improvements">Improvements</a></li>
+<li class="toctree-l3"><a class="reference internal" href="release_note.html#known-vulnerabilities">Known Vulnerabilities</a></li>
+<li class="toctree-l3"><a class="reference internal" href="release_note.html#resolved-vulnerabilities">Resolved Vulnerabilities</a></li>
+<li class="toctree-l3"><a class="reference internal" href="release_note.html#change-log">Change Log</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="code_style.html">Code Style</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="code_style.html#license-a-name-license-a">License <a name="license"></a></a></li>
+</ul>
+</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">fabric-sdk-py</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>&lt;no title&gt;</li>
+
+
+      <li class="wy-breadcrumbs-aside">
+
+
+            <a href="_sources/CONTRIBUTING.md.txt" rel="nofollow"> View page source</a>
+
+
+      </li>
+
+  </ul>
+
+
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <p>../../CONTRIBUTING.md</p>
+
+
+           </div>
+
+          </div>
+          <footer>
+
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+
+        <a href="code_style.html" class="btn btn-neutral float-left" title="Python Coding Style" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+    </div>
+
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Hyperledger Community
+
+    </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">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(false);
+      });
+  </script>
+
+
+
+
+
+
+</body>
+</html>
diff --git a/docs/build/html/_sources/CONTRIBUTING.md.txt b/docs/build/html/_sources/CONTRIBUTING.md.txt
@@ -0,0 +1 @@
+../../CONTRIBUTING.md
diff --git a/docs/code_style.md → docs/build/html/_sources/code_style.md.txt b/docs/code_style.md → docs/build/html/_sources/code_style.md.txt
diff --git a/docs/build/html/_sources/index.md.txt b/docs/build/html/_sources/index.md.txt
@@ -0,0 +1,9 @@
+Welcome to fabric-sdk-py's documentation!
+=========================================
+
+## Package Reference
+
+* [Tutorial](tutorial.md)
+* [Release Note](release_note.md)
+* [Code Style](code_style.md)
+* [Contributing](CONTRIBUTING.md)
diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt
@@ -0,0 +1,13 @@
+Welcome to fabric-sdk-py's documentation!
+=========================================
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Package Reference
+
+    self
+
+.. mdinclude: tutorial.md
+.. mdinclude: release_note.md
+
+
diff --git a/docs/release_note.md → docs/build/html/_sources/release_note.md.txt b/docs/release_note.md → docs/build/html/_sources/release_note.md.txt
diff --git a/docs/tutorial.md → docs/build/html/_sources/tutorial.md.txt b/docs/tutorial.md → docs/build/html/_sources/tutorial.md.txt