using a dedicated folder for documentation in each subproject

git-svn-id: https://vsmartcard.svn.sourceforge.net/svnroot/vsmartcard@587 96b47cad-a561-4643-ad3b-153ac7d7599c

doc/_static/doxygen-npa

@@ -1 +1 @@
-../doxygen/npa/html
+../npa/html

doc/ccid

@@ -0,0 +1 @@
+../ccid/doc

doc/ccid.rst

@@ -1 +0,0 @@
-../ccid/README

doc/conf.py

@@ -216,7 +216,7 @@ man_pages = [
      [u'Dominik Oepen, Frank Morgner'], 1)
 ]
 
-os.system("make doc -C ../npa/ >/dev/null && touch npaapi.rst")
-breathe_projects = {"npa": "doxygen/npa/xml"}
+os.system("cd npa && make doc >/dev/null && touch api.rst")
+breathe_projects = {"npa": "npa/xml"}
 breathe_default_project = "npa"
-doxylink = { 'npa' : ('doxygen/npa/npa.tag', '_static/doxygen-npa/'), }
+doxylink = { 'npa' : ('npa/npa.tag', '_static/doxygen-npa/'), }

doc/doxygen/npa

@@ -1 +0,0 @@
-../../npa/doc/

doc/index.rst

@@ -12,10 +12,10 @@ Currently the following projects are part of vsmartcard:
 
 .. toctree::
 
-   virtualsmartcard
-   pcsc-relay
-   npa
-   ccid
+   virtualsmartcard/README
+   pcsc-relay/README
+   npa/README
+   ccid/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
@@ -23,7 +23,7 @@ have a look at these programming guides and try yourself:
 
 .. toctree::
 
-   npaapi
+   npa/api
 
 Download
 ========

doc/npa

@@ -0,0 +1 @@
+../npa/doc

doc/npa.rst

@@ -1 +0,0 @@
-../npa/README

doc/npaapi.rst

@@ -1,82 +0,0 @@
-.. highlight:: c
-
-********************************
-Programming with the nPA Library
-********************************
-
-The nPA library includes a generic implementation for Secure Messaging (SM),
-which might also be used in conjunction with other cards. It is implemented to
-be close to ISO 7816-8 focusing only on encoding rather than implementing
-everything that is needed to get a secure channel. All cryptographic work is
-done by call back functions, which should be appropriatly set for the specific
-card.
-
-Using the German identity card (neuer Personalausweis, nPA) requires user
-authentication via entry of the PIN. Transmitting the PIN in plaintext is
-risky, since it would be transmitted over the air and could be snooped. That's
-why the PACE keyagreement is used to verify the PIN and establish an SM channel
-to the nPA. :npa:`EstablishPACEChannel` does exactly that and if everything
-went fine, it initializes :npa:`sm_ctx` for use of the SM channel. Now
-:npa:`sm_transmit_apdu` can be used to securely transmit arbitrary APDUs to the
-card. You could for example change your PIN or even continue the Extended
-Access Control (EAC) with Terminal Authentication (TA) and Chit Authenitcation
-(CA).
-
-Please consider the following overview to the API as incomplete. The `Doxygen
-documentation <_static/doxygen-npa/modules.html>`_ should be used as programmer's
-reference since it is more detailed.
-
-=====================
-Secure Messaging (SM)
-=====================
-
-The complete documentation can be found `here
-<_static/doxygen-npa/group__sm.html>`_.
-
------
-Types
------
-.. doxygenstruct:: sm_ctx
-
----------
-Functions
----------
-.. doxygenfunction:: sm_transmit_apdu
-.. doxygenfunction:: sm_ctx_clear_free
-
-==============================================================
-Interface to German identity card (neuer Personalausweis, nPA)
-==============================================================
-
-The complete documentation can be found `here
-<_static/doxygen-npa/group__npa.html>`_.
-
------
-Types
------
-.. doxygenstruct:: establish_pace_channel_input
-.. doxygenstruct:: establish_pace_channel_output
-
----------
-Functions
----------
-.. doxygenfunction:: EstablishPACEChannel
-.. doxygenfunction:: npa_reset_retry_counter
-
--------
-Defines
--------
-.. doxygendefine:: npa_change_pin
-.. doxygendefine:: npa_unblock_pin
-
-=======
-Example
-=======
-
-In order to compile and execute this example you need to correctly :ref:`set up
-your environment <npa-usage>`.
-
-.. literalinclude:: ../npa/src/example.c
-    :lines: 20-
-
-.. @author Frank Morgner <morgner@informatik.hu-berlin.de>

doc/pcsc-relay

@@ -0,0 +1 @@
+../pcsc-relay/doc

doc/pcsc-relay.rst

@@ -1 +0,0 @@
-../pcsc-relay/README

doc/virtualsmartcard

@@ -0,0 +1 @@
+../virtualsmartcard/doc

doc/virtualsmartcard.rst

@@ -1 +0,0 @@
-../virtualsmartcard/README