updated documentation

- use a more compact summary - remove libnpa from the navigation
vaginessa · Oct 12, 2016 · 6b13057 · 6b13057
1 parent ee1f538
commit 6b13057
Show file tree

Hide file tree

Showing 46 changed files with 132 additions and 315 deletions.
diff --git a/ACardEmulator/doc/README.txt b/ACardEmulator/doc/README.txt
@@ -8,12 +8,8 @@
 Android Smart Card Emulator
 ################################################################################
 
-.. sidebar:: Summary
+.. sidebar:: Use an Android phone as contact-less smart card
 
-    Use an Android phone as contact-less smart card
-
-    :Author:
-        `Frank Morgner <[email protected]>`_
     :License:
         GPL version 3
     :Tested Platform:

diff --git a/ccid/doc/README.txt.in b/ccid/doc/README.txt.in
@@ -8,12 +8,8 @@
 @PACKAGE_NAME@
 ################################################################################
 
-.. sidebar:: Summary
+.. sidebar:: @PACKAGE_SUMMARY@
 
-    @PACKAGE_SUMMARY@
-
-    :Author:
-        `Frank Morgner <[email protected]>`_
     :License:
         GPL version 3
     :Tested Platforms:

diff --git a/doc/index.txt b/doc/index.txt
@@ -51,11 +51,6 @@ Currently the following projects are part of |vsmartcard|:
    pcsc-relay/README
    ccid/README
 
-.. toctree::
-   :hidden:
-
-   npa/README
-
 Looking for a feature the included programs do not offer? Want to extend the
 functionality of some library? Apart from requesting a new feature, you can
 have a look at these programming guides and try yourself:

diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +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: 7e1b6e23f76ebb388595dd1cdef3e43e
+config: db554396ed8a19f8462752faa93169b8
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/ACardEmulator/README.html b/docs/ACardEmulator/README.html
@@ -5,7 +5,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Android Smart Card Emulator &mdash; vsmartcard 2016-10-10 documentation</title>
+    <title>Android Smart Card Emulator &mdash; vsmartcard 2016-10-12 documentation</title>
 
     <link rel="stylesheet" href="../_static/basic.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '2016-10-10',
+        VERSION:     '2016-10-12',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -29,7 +29,7 @@
     <script type="text/javascript" src="../_static/bootstrap-3.3.4/js/bootstrap.min.js"></script>
     <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
     <link rel="shortcut icon" href="../_static/chip.ico"/>
-    <link rel="top" title="vsmartcard 2016-10-10 documentation" href="../index.html" />
+    <link rel="top" title="vsmartcard 2016-10-12 documentation" href="../index.html" />
     <link rel="next" title="PC/SC Relay" href="../pcsc-relay/README.html" />
     <link rel="prev" title="Remote Smart Card Reader" href="../remote-reader/README.html" />
 <meta charset='utf-8'>
@@ -89,9 +89,6 @@
 <li class="toctree-l1"><a class="reference internal" href="../ccid/README.html">USB CCID Emulator</a></li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../npa/README.html">nPA Smart Card Library</a></li>
-</ul>
-<ul>
 <li class="toctree-l1"><a class="reference internal" href="../virtualsmartcard/api.html">Creating a Virtual Smart Card</a></li>
 </ul>
 </ul>
@@ -158,18 +155,15 @@
   <div class="section" id="android-smart-card-emulator">
 <span id="acardemulator"></span><h1>Android Smart Card Emulator<a class="headerlink" href="#android-smart-card-emulator" title="Permalink to this headline">¶</a></h1>
 <div class="sidebar">
-<p class="first sidebar-title">Summary</p>
-<p>Use an Android phone as contact-less smart card</p>
+<p class="first sidebar-title">Use an Android phone as contact-less smart card</p>
 <table class="last docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Author:</th><td class="field-body"><a class="reference external" href="mailto:frankmorgner&#37;&#52;&#48;gmail&#46;com">Frank Morgner</a></td>
-</tr>
-<tr class="field-even field"><th class="field-name">License:</th><td class="field-body">GPL version 3</td>
+<tr class="field-odd field"><th class="field-name">License:</th><td class="field-body">GPL version 3</td>
 </tr>
-<tr class="field-odd field"><th class="field-name" colspan="2">Tested Platform:</th></tr>
-<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">Android, CyanogenMod</td>
+<tr class="field-even field"><th class="field-name" colspan="2">Tested Platform:</th></tr>
+<tr class="field-even field"><td>&nbsp;</td><td class="field-body">Android, CyanogenMod</td>
 </tr>
 </tbody>
 </table>

diff --git a/docs/_sources/ACardEmulator/README.txt b/docs/_sources/ACardEmulator/README.txt
@@ -8,12 +8,8 @@
 Android Smart Card Emulator
 ################################################################################
 
-.. sidebar:: Summary
+.. sidebar:: Use an Android phone as contact-less smart card
 
-    Use an Android phone as contact-less smart card
-
-    :Author:
-        `Frank Morgner <[email protected]>`_
     :License:
         GPL version 3
     :Tested Platform:

diff --git a/docs/_sources/ccid/README.txt b/docs/_sources/ccid/README.txt
@@ -8,12 +8,8 @@
 USB CCID Emulator
 ################################################################################
 
-.. sidebar:: Summary
+.. sidebar:: Emulate a USB CCID compliant smart card reader
 
-    Emulate a USB CCID compliant smart card reader
-
-    :Author:
-        `Frank Morgner <[email protected]>`_
     :License:
         GPL version 3
     :Tested Platforms:

diff --git a/docs/_sources/index.txt b/docs/_sources/index.txt
@@ -51,11 +51,6 @@ Currently the following projects are part of |vsmartcard|:
    pcsc-relay/README
    ccid/README
 
-.. toctree::
-   :hidden:
-
-   npa/README
-
 Looking for a feature the included programs do not offer? Want to extend the
 functionality of some library? Apart from requesting a new feature, you can
 have a look at these programming guides and try yourself:

diff --git a/docs/_sources/pcsc-relay/README.txt b/docs/_sources/pcsc-relay/README.txt
@@ -6,13 +6,8 @@
 PC/SC Relay
 ################################################################################
 
-.. sidebar:: Summary
+.. sidebar:: Relay a smart card to a contactless interface
 
-  Relay a smart card to a contactless interface
-
-  :Authors:
-      - `Frank Morgner <[email protected]>`_
-      - `Dominik Oepen <[email protected]>`_
   :License:
       GPL version 3
   :Tested Platforms:

diff --git a/docs/_sources/remote-reader/README.txt b/docs/_sources/remote-reader/README.txt
@@ -8,12 +8,8 @@
 Remote Smart Card Reader
 ################################################################################
 
-.. sidebar:: Summary
+.. sidebar:: Use an Android phone as contact-less smart card reader
 
-    Use an Android phone as contact-less smart card reader
-
-    :Author:
-        `Frank Morgner <[email protected]>`_
     :License:
         GPL version 3
     :Tested Platform:

diff --git a/docs/_sources/virtualsmartcard/README.txt b/docs/_sources/virtualsmartcard/README.txt
@@ -14,18 +14,13 @@
 Virtual Smart Card
 ################################################################################
 
-.. sidebar:: Summary
+.. sidebar:: Smart card emulator written in Python
 
-    Smart card emulator written in Python
-
-  :Authors:
-      - `Frank Morgner <[email protected]>`_
-      - `Dominik Oepen <[email protected]>`_
   :License:
       GPL version 3
   :Tested Platforms:
       - Windows
-      - Mac OS X
+      - macOS
       - Linux (Debian, Ubuntu, OpenMoko)
 
 Virtual Smart Card emulates a smart card and makes it accessible through PC/SC.

diff --git a/docs/ccid/README.html b/docs/ccid/README.html
@@ -5,7 +5,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>USB CCID Emulator &mdash; vsmartcard 2016-10-10 documentation</title>
+    <title>USB CCID Emulator &mdash; vsmartcard 2016-10-12 documentation</title>
 
     <link rel="stylesheet" href="../_static/basic.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '2016-10-10',
+        VERSION:     '2016-10-12',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -29,8 +29,8 @@
     <script type="text/javascript" src="../_static/bootstrap-3.3.4/js/bootstrap.min.js"></script>
     <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
     <link rel="shortcut icon" href="../_static/chip.ico"/>
-    <link rel="top" title="vsmartcard 2016-10-10 documentation" href="../index.html" />
-    <link rel="next" title="nPA Smart Card Library" href="../npa/README.html" />
+    <link rel="top" title="vsmartcard 2016-10-12 documentation" href="../index.html" />
+    <link rel="next" title="Creating a Virtual Smart Card" href="../virtualsmartcard/api.html" />
     <link rel="prev" title="PC/SC Relay" href="../pcsc-relay/README.html" />
 <meta charset='utf-8'>
 <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
@@ -89,9 +89,6 @@
 <li class="toctree-l1 current"><a class="current reference internal" href="">USB CCID Emulator</a></li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../npa/README.html">nPA Smart Card Library</a></li>
-</ul>
-<ul>
 <li class="toctree-l1"><a class="reference internal" href="../virtualsmartcard/api.html">Creating a Virtual Smart Card</a></li>
 </ul>
 </ul>
@@ -132,7 +129,7 @@
     </a>
   </li>
   <li>
-    <a href="../npa/README.html" title="Next Chapter: nPA Smart Card Library"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">nPA Smart Card L... &raquo;</span>
+    <a href="../virtualsmartcard/api.html" title="Next Chapter: Creating a Virtual Smart Card"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Creating a Virtu... &raquo;</span>
     </a>
   </li>
 
@@ -165,18 +162,15 @@
   <div class="section" id="usb-ccid-emulator">
 <span id="ccid-emulator"></span><h1>USB CCID Emulator<a class="headerlink" href="#usb-ccid-emulator" title="Permalink to this headline">¶</a></h1>
 <div class="sidebar">
-<p class="first sidebar-title">Summary</p>
-<p>Emulate a USB CCID compliant smart card reader</p>
+<p class="first sidebar-title">Emulate a USB CCID compliant smart card reader</p>
 <table class="last docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Author:</th><td class="field-body"><a class="reference external" href="mailto:frankmorgner&#37;&#52;&#48;gmail&#46;com">Frank Morgner</a></td>
-</tr>
-<tr class="field-even field"><th class="field-name">License:</th><td class="field-body">GPL version 3</td>
+<tr class="field-odd field"><th class="field-name">License:</th><td class="field-body">GPL version 3</td>
 </tr>
-<tr class="field-odd field"><th class="field-name" colspan="2">Tested Platforms:</th></tr>
-<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">Linux (Debian, Ubuntu, OpenMoko)</td>
+<tr class="field-even field"><th class="field-name" colspan="2">Tested Platforms:</th></tr>
+<tr class="field-even field"><td>&nbsp;</td><td class="field-body">Linux (Debian, Ubuntu, OpenMoko)</td>
 </tr>
 </tbody>
 </table>

diff --git a/docs/index.html b/docs/index.html
@@ -5,7 +5,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Welcome to the Virtual Smart Card Architecture documentation! &mdash; vsmartcard 2016-10-10 documentation</title>
+    <title>Welcome to the Virtual Smart Card Architecture documentation! &mdash; vsmartcard 2016-10-12 documentation</title>
 
     <link rel="stylesheet" href="_static/basic.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    './',
-        VERSION:     '2016-10-10',
+        VERSION:     '2016-10-12',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -29,7 +29,7 @@
     <script type="text/javascript" src="_static/bootstrap-3.3.4/js/bootstrap.min.js"></script>
     <script type="text/javascript" src="_static/bootstrap-sphinx.js"></script>
     <link rel="shortcut icon" href="_static/chip.ico"/>
-    <link rel="top" title="vsmartcard 2016-10-10 documentation" href="#" />
+    <link rel="top" title="vsmartcard 2016-10-12 documentation" href="#" />
     <link rel="next" title="Virtual Smart Card" href="virtualsmartcard/README.html" />
 <meta charset='utf-8'>
 <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
@@ -88,9 +88,6 @@
 <li class="toctree-l1"><a class="reference internal" href="ccid/README.html">USB CCID Emulator</a></li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="npa/README.html">nPA Smart Card Library</a></li>
-</ul>
-<ul>
 <li class="toctree-l1"><a class="reference internal" href="virtualsmartcard/api.html">Creating a Virtual Smart Card</a></li>
 </ul>
 </ul>
@@ -199,8 +196,6 @@ <h1>Welcome to the Virtual Smart Card Architecture documentation!<a class="heade
 </li>
 </ul>
 </div>
-<div class="toctree-wrapper compound">
-</div>
 <p>Looking for a feature the included programs do not offer? Want to extend the
 functionality of some library? Apart from requesting a new feature, you can
 have a look at these programming guides and try yourself:</p>

diff --git a/docs/npa/README.html b/docs/npa/README.html
@@ -6,7 +6,7 @@
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <meta content="0;URL='https://github.com/frankmorgner/OpenSC'" http-equiv="refresh" />
 
-    <title>nPA Smart Card Library &mdash; vsmartcard 2016-10-10 documentation</title>
+    <title>nPA Smart Card Library &mdash; vsmartcard 2016-10-12 documentation</title>
 
     <link rel="stylesheet" href="../_static/basic.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -16,7 +16,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '2016-10-10',
+        VERSION:     '2016-10-12',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -30,9 +30,7 @@
     <script type="text/javascript" src="../_static/bootstrap-3.3.4/js/bootstrap.min.js"></script>
     <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
     <link rel="shortcut icon" href="../_static/chip.ico"/>
-    <link rel="top" title="vsmartcard 2016-10-10 documentation" href="../index.html" />
-    <link rel="next" title="Creating a Virtual Smart Card" href="../virtualsmartcard/api.html" />
-    <link rel="prev" title="USB CCID Emulator" href="../ccid/README.html" />
+    <link rel="top" title="vsmartcard 2016-10-12 documentation" href="../index.html" />
 <meta charset='utf-8'>
 <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
 <meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
@@ -89,9 +87,6 @@
 <li class="toctree-l1"><a class="reference internal" href="../pcsc-relay/README.html">PC/SC Relay</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../ccid/README.html">USB CCID Emulator</a></li>
 </ul>
-<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="">nPA Smart Card Library</a></li>
-</ul>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../virtualsmartcard/api.html">Creating a Virtual Smart Card</a></li>
 </ul>
@@ -116,14 +111,6 @@
 
 
 
-  <li>
-    <a href="../ccid/README.html" title="Previous Chapter: USB CCID Emulator"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">&laquo; USB CCID Emulato...</span>
-    </a>
-  </li>
-  <li>
-    <a href="../virtualsmartcard/api.html" title="Next Chapter: Creating a Virtual Smart Card"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Creating a Virtu... &raquo;</span>
-    </a>
-  </li>
 
 
 

diff --git a/docs/objects.inv b/docs/objects.inv