respect sphinx style guide to some extent

see http://documentation-style-guide-sphinx.readthedocs.org/en/latest/style-guide.html

virtualsmartcard/doc/Makefile.am

@@ -17,16 +17,16 @@ do_subst = $(SED) \
 	   -e 's,[@]abs_top_srcdir[@],$(abs_top_srcdir),g' \
 	   -e 's,[@]top_srcdir[@],$(top_srcdir),g'
 
-EXTRA_DIST = README.rst.in README.rst autotools.rst.in questions.rst.in autotools.rst questions.rst download.rst.in download.rst
+EXTRA_DIST = README.txt.in README.txt autotools.txt.in questions.txt.in autotools.txt questions.txt download.txt.in download.txt
 
 dist_noinst_SCRIPTS = generate_modules.py
 
 doc: $(top_srcdir)/src/vpicc/virtualsmartcard/*.py $(top_srcdir)/src/vpicc/virtualsmartcard/cards/*.py generate_modules.py *.in
-	$(do_subst) < autotools.rst.in > autotools.rst
-	$(do_subst) < questions.rst.in > questions.rst
-	$(do_subst) < download.rst.in  > download.rst
-	$(do_subst) < README.rst.in > README.rst
-	./generate_modules.py $(top_srcdir)/src/vpicc --dest-dir=api --suffix=rst --no-toc -1 -f
+	$(do_subst) < autotools.txt.in > autotools.txt
+	$(do_subst) < questions.txt.in > questions.txt
+	$(do_subst) < download.txt.in  > download.txt
+	$(do_subst) < README.txt.in  > README.txt
+	./generate_modules.py $(top_srcdir)/src/vpicc --dest-dir=api --suffix=txt --no-toc -1 -f
 	touch doc
 
 clean-local:

virtualsmartcard/doc/README.txt

@@ -1,14 +1,5 @@
 .. highlight:: sh
 
-.. _PBKDF2: https://www.dlitz.net/software/python-pbkdf2/
-.. _PCSC-lite: http://pcsclite.alioth.debian.org/
-.. _PCSC-lite: http://pcsclite.alioth.debian.org/
-.. _PIP: http://www.pythonware.com/products/pil/
-.. _PyCrypto: http://pycrypto.org/
-.. _Python: http://www.python.org/
-.. _cyberflex-shell: https://github.com/henryk/cyberflex-shell
-.. _pyscard: http://pyscard.sourceforge.net/
-
 .. |vpicc| replace:: :abbr:`vpicc (virtual smart card)`
 .. |vpcd| replace:: :abbr:`vpcd (virtual smart card reader)`
 .. |EAC| replace:: :abbr:`EAC (Extended Access Control)`
@@ -19,9 +10,9 @@
 
 .. _vicc:
 
-********************************************************************************
+##################
 Virtual Smart Card
-********************************************************************************
+##################
 
 :Authors:
     - Frank Morgner <morgner@informatik.hu-berlin.de>
@@ -55,10 +46,10 @@ reader.
 The file :file:`utils.py` was taken from Henryk Plötz's cyberflex-shell_.
 
 
-.. include:: download.rst
+.. include:: download.txt
 
 
-.. include:: autotools.rst
+.. include:: autotools.txt
 
 Depending on your usage of the |vpicc| you might or might not need
 the following:
@@ -72,11 +63,11 @@ the following:
 The |vpcd| depends on PCSC-Lite_.
 
 
-================================================================================
+******************************
 Running the Virtual Smart Card
-================================================================================
+******************************
 
-First you need to make sure that :command:`pcscd` loads the |vpcd|. You might
+Fitxt you need to make sure that :command:`pcscd` loads the |vpcd|. You might
 need to run :command:`update-reader.conf` to update its configuration file.
 Then :command:`pcscd -f -d` should say something like "Attempting startup of
 Virtual PCD"
@@ -90,9 +81,10 @@ You should now be able to access the |vpicc| through the PC/SC API via
 |vpcd|/:command:`pcscd`. You can use the :command:`opensc-explorer` or
 :command:`pcsc_scan` for testing.
 
---------------------------------------------------------------------------------
+
+==========================================================
 Accessing the Virtual Smart Card from Windows applications
---------------------------------------------------------------------------------
+==========================================================
 
 Running |vpcd| under Windows is currently not supported, because it implements
 a smart card driver specific for PCSC-Lite (:command:`pcscd`). This means, that
@@ -120,4 +112,19 @@ However, there are several more or less complicated paths you can go:
   PC/SC provider for a native Windows application.
 
 
-.. include:: questions.rst
+.. include:: questions.txt
+
+
+********************
+Notes and References
+********************
+
+.. target-notes::
+
+.. _PBKDF2: https://www.dlitz.net/software/python-pbkdf2/
+.. _PCSC-lite: http://pcsclite.alioth.debian.org/
+.. _PIP: http://www.pythonware.com/products/pil/
+.. _PyCrypto: http://pycrypto.org/
+.. _Python: http://www.python.org/
+.. _cyberflex-shell: https://github.com/henryk/cyberflex-shell
+.. _pyscard: http://pyscard.sourceforge.net/

virtualsmartcard/doc/README.txt.in

@@ -1,14 +1,5 @@
 .. highlight:: sh
 
-.. _PBKDF2: https://www.dlitz.net/software/python-pbkdf2/
-.. _PCSC-lite: http://pcsclite.alioth.debian.org/
-.. _PCSC-lite: http://pcsclite.alioth.debian.org/
-.. _PIP: http://www.pythonware.com/products/pil/
-.. _PyCrypto: http://pycrypto.org/
-.. _Python: http://www.python.org/
-.. _cyberflex-shell: https://github.com/henryk/cyberflex-shell
-.. _pyscard: http://pyscard.sourceforge.net/
-
 .. |vpicc| replace:: :abbr:`vpicc (virtual smart card)`
 .. |vpcd| replace:: :abbr:`vpcd (virtual smart card reader)`
 .. |EAC| replace:: :abbr:`EAC (Extended Access Control)`
@@ -19,9 +10,9 @@
 
 .. _vicc:
 
-********************************************************************************
-@PACKAGE_NAME@
-********************************************************************************
+##################
+Virtual Smart Card
+##################
 
 :Authors:
     - Frank Morgner <morgner@informatik.hu-berlin.de>
@@ -34,8 +25,8 @@
 :Potential Platforms:
     Unix-like operating systems (Mac OS, Solaris, BSD, ...)
 
-@PACKAGE_NAME@ emulates a smart card and makes it accessible through PC/SC.
-Currently the @PACKAGE_NAME@ supports the following types of smart cards:
+Virtual Smart Card emulates a smart card and makes it accessible through PC/SC.
+Currently the Virtual Smart Card supports the following types of smart cards:
 
 - Generic ISO-7816 smart card including secure messaging
 - German electronic identity card (nPA) with complete support for |EAC| (|PACE|, |TA|, |CA|)
@@ -48,17 +39,17 @@ default |vpicc| communicates with |vpcd| through a socket on localhost port
 35963. But the |vpicc| does not need to run on the same machine as the |vpcd|,
 they can connect over the internet for example.
 
-Although the @PACKAGE_NAME@ is a software emulator, you can use
+Although the Virtual Smart Card is a software emulator, you can use
 :ref:`pcsc-relay` to make it accessible to an external contact-less smart card
 reader.
 
 The file :file:`utils.py` was taken from Henryk Plötz's cyberflex-shell_.
 
 
-.. include:: download.rst
+.. include:: download.txt
 
 
-.. include:: autotools.rst
+.. include:: autotools.txt
 
 Depending on your usage of the |vpicc| you might or might not need
 the following:
@@ -72,11 +63,11 @@ the following:
 The |vpcd| depends on PCSC-Lite_.
 
 
-================================================================================
-Running the @PACKAGE_NAME@
-================================================================================
+******************************
+Running the Virtual Smart Card
+******************************
 
-First you need to make sure that :command:`pcscd` loads the |vpcd|. You might
+Fitxt you need to make sure that :command:`pcscd` loads the |vpcd|. You might
 need to run :command:`update-reader.conf` to update its configuration file.
 Then :command:`pcscd -f -d` should say something like "Attempting startup of
 Virtual PCD"
@@ -90,9 +81,10 @@ You should now be able to access the |vpicc| through the PC/SC API via
 |vpcd|/:command:`pcscd`. You can use the :command:`opensc-explorer` or
 :command:`pcsc_scan` for testing.
 
---------------------------------------------------------------------------------
-Accessing the @PACKAGE_NAME@ from Windows applications
---------------------------------------------------------------------------------
+
+==========================================================
+Accessing the Virtual Smart Card from Windows applications
+==========================================================
 
 Running |vpcd| under Windows is currently not supported, because it implements
 a smart card driver specific for PCSC-Lite (:command:`pcscd`). This means, that
@@ -120,4 +112,19 @@ However, there are several more or less complicated paths you can go:
   PC/SC provider for a native Windows application.
 
 
-.. include:: questions.rst
+.. include:: questions.txt
+
+
+********************
+Notes and References
+********************
+
+.. target-notes::
+
+.. _PBKDF2: https://www.dlitz.net/software/python-pbkdf2/
+.. _PCSC-lite: http://pcsclite.alioth.debian.org/
+.. _PIP: http://www.pythonware.com/products/pil/
+.. _PyCrypto: http://pycrypto.org/
+.. _Python: http://www.python.org/
+.. _cyberflex-shell: https://github.com/henryk/cyberflex-shell
+.. _pyscard: http://pyscard.sourceforge.net/

virtualsmartcard/doc/api/virtualsmartcard.CardGenerator.txt

@@ -0,0 +1,10 @@
+CardGenerator Module
+====================
+
+.. inheritance-diagram:: virtualsmartcard.CardGenerator
+.. automodule:: virtualsmartcard.CardGenerator
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+    :private-members:

virtualsmartcard/doc/api/virtualsmartcard.ConstantDefinitions.txt

@@ -0,0 +1,10 @@
+ConstantDefinitions Module
+==========================
+
+.. inheritance-diagram:: virtualsmartcard.ConstantDefinitions
+.. automodule:: virtualsmartcard.ConstantDefinitions
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+    :private-members:

virtualsmartcard/doc/api/virtualsmartcard.CryptoUtils.txt

@@ -0,0 +1,10 @@
+CryptoUtils Module
+==================
+
+.. inheritance-diagram:: virtualsmartcard.CryptoUtils
+.. automodule:: virtualsmartcard.CryptoUtils
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+    :private-members:

virtualsmartcard/doc/api/virtualsmartcard.SEutils.txt

@@ -0,0 +1,10 @@
+SEutils Module
+==============
+
+.. inheritance-diagram:: virtualsmartcard.SEutils
+.. automodule:: virtualsmartcard.SEutils
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+    :private-members:

virtualsmartcard/doc/api/virtualsmartcard.SWutils.txt

@@ -0,0 +1,10 @@
+SWutils Module
+==============
+
+.. inheritance-diagram:: virtualsmartcard.SWutils
+.. automodule:: virtualsmartcard.SWutils
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+    :private-members:

virtualsmartcard/doc/api/virtualsmartcard.SmartcardFilesystem.txt

@@ -0,0 +1,10 @@
+SmartcardFilesystem Module
+==========================
+
+.. inheritance-diagram:: virtualsmartcard.SmartcardFilesystem
+.. automodule:: virtualsmartcard.SmartcardFilesystem
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+    :private-members:

virtualsmartcard/doc/api/virtualsmartcard.SmartcardSAM.txt

@@ -0,0 +1,10 @@
+SmartcardSAM Module
+===================
+
+.. inheritance-diagram:: virtualsmartcard.SmartcardSAM
+.. automodule:: virtualsmartcard.SmartcardSAM
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+    :private-members:

virtualsmartcard/doc/api/virtualsmartcard.TLVutils.txt

@@ -0,0 +1,10 @@
+TLVutils Module
+===============
+
+.. inheritance-diagram:: virtualsmartcard.TLVutils
+.. automodule:: virtualsmartcard.TLVutils
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+    :private-members:

virtualsmartcard/doc/api/virtualsmartcard.VirtualSmartcard.txt

@@ -0,0 +1,10 @@
+VirtualSmartcard Module
+=======================
+
+.. inheritance-diagram:: virtualsmartcard.VirtualSmartcard
+.. automodule:: virtualsmartcard.VirtualSmartcard
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+    :private-members:

virtualsmartcard/doc/api/virtualsmartcard.cards.cryptoflex.txt

@@ -0,0 +1,10 @@
+cryptoflex Module
+=================
+
+.. inheritance-diagram:: virtualsmartcard.cards.cryptoflex
+.. automodule:: virtualsmartcard.cards.cryptoflex
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+    :private-members:

virtualsmartcard/doc/api/virtualsmartcard.cards.ePass.txt

@@ -0,0 +1,10 @@
+ePass Module
+============
+
+.. inheritance-diagram:: virtualsmartcard.cards.ePass
+.. automodule:: virtualsmartcard.cards.ePass
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+    :private-members:

virtualsmartcard/doc/api/virtualsmartcard.cards.nPA.txt

@@ -0,0 +1,10 @@
+nPA Module
+==========
+
+.. inheritance-diagram:: virtualsmartcard.cards.nPA
+.. automodule:: virtualsmartcard.cards.nPA
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+    :private-members:

virtualsmartcard/doc/api/virtualsmartcard.cards.txt

@@ -0,0 +1,9 @@
+cards Package
+=============
+
+.. toctree::
+
+    virtualsmartcard.cards.cryptoflex
+    virtualsmartcard.cards.ePass
+    virtualsmartcard.cards.nPA
+

virtualsmartcard/doc/api/virtualsmartcard.txt

@@ -0,0 +1,17 @@
+virtualsmartcard Package
+========================
+
+.. toctree::
+
+    virtualsmartcard.cards
+    virtualsmartcard.CardGenerator
+    virtualsmartcard.ConstantDefinitions
+    virtualsmartcard.CryptoUtils
+    virtualsmartcard.SEutils
+    virtualsmartcard.SWutils
+    virtualsmartcard.SmartcardFilesystem
+    virtualsmartcard.SmartcardSAM
+    virtualsmartcard.TLVutils
+    virtualsmartcard.VirtualSmartcard
+    virtualsmartcard.utils
+

virtualsmartcard/doc/api/virtualsmartcard.utils.txt

@@ -0,0 +1,10 @@
+utils Module
+============
+
+.. inheritance-diagram:: virtualsmartcard.utils
+.. automodule:: virtualsmartcard.utils
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+    :private-members:

virtualsmartcard/doc/autotools.rst.in

@@ -1 +0,0 @@
-../../doc/autotools.rst.in

virtualsmartcard/doc/autotools.txt

@@ -1,8 +1,8 @@
 .. highlight:: sh
 
-============
+************
 Installation
-============
+************
 
 The Virtual Smart Card uses the GNU Build System to compile and install. If you are
 unfamiliar with it, please have a look at :file:`INSTALL`. If you have a look

virtualsmartcard/doc/autotools.txt.in

@@ -0,0 +1 @@
+../../doc/autotools.txt.in

virtualsmartcard/doc/download.rst.in

@@ -1 +0,0 @@
-../../doc/download.rst.in

virtualsmartcard/doc/download.txt

@@ -1,8 +1,8 @@
 .. highlight:: sh
 
-===============================================================================
+********
 Download
-===============================================================================
+********
 
 You can find the latest release of Virtual Smart Card `here
 <http://sourceforge.net/projects/vsmartcard/files>`_.

virtualsmartcard/doc/download.txt.in

@@ -0,0 +1 @@
+../../doc/download.txt.in

virtualsmartcard/doc/questions.rst.in

@@ -1 +0,0 @@
-../../doc/questions.rst.in

virtualsmartcard/doc/questions.txt

@@ -1,6 +1,6 @@
-========
+********
 Question
-========
+********
 
 Do you have questions, suggestions or contributions? Feedback of any kind is
 more than welcome! Please use our `project trackers <http://sourceforge.net/projects/vsmartcard/support>`_.

virtualsmartcard/doc/questions.txt.in

@@ -0,0 +1 @@
+../../doc/questions.txt.in