- worked around warnings of sphinx

- using generic file for questions for all subprojects


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

ccid/doc/Makefile.am

@@ -10,11 +10,12 @@ do_subst = sed \
 	   -e 's,[@]OPENSC_LIBS[@],$(OPENSC_LIBS),g' \
 	   -e 's,[@]top_srcdir[@],$(top_srcdir),g'
 
-EXTRA_DIST = README.rst autotools.rst.in
+EXTRA_DIST = README.rst autotools.rst.in questions.rst.in
 
 .PHONY: doc
 doc:
 	$(do_subst) < autotools.rst.in > autotools.rst
+	$(do_subst) < questions.rst.in > questions.rst
 
 clean-local:
-	rm -f autotools.rst
+	rm -f autotools.rst questions.rst

ccid/doc/README.rst

@@ -28,10 +28,6 @@ ccid-emulator is implemented using GadgetFS_. Some fragments of the source code
 are based on the GadgetFS example and on the source code of the OpenSC_ tools.
 
 
-=============
-Installation
-=============
-
 .. include:: autotools.rst
 
 ccid as the following dependencies:
@@ -100,9 +96,4 @@ PACE support (such as ccid-emulator or any other "Standardleser" CAT-S or
 "Komfortleser" CAT-C) via PC/SC.
 
 
-=========
+.. include:: questions.rst
-Questions
-=========
-
-For questions, please use http://sourceforge.net/projects/vsmartcard/support
-

ccid/doc/questions.rst.in

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

doc/autotools.rst.in

@@ -1,5 +1,9 @@
 .. highlight:: sh
 
+=============
+Installation
+=============
+
 @PACKAGE_NAME@ 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
 around and can not find it, you are probably working bleeding edge in the

doc/conf.py

@@ -12,6 +12,7 @@
 # serve to show the default.
 
 import sys, os, breathe
+from sphinxcontrib.doxylink import doxylink
 
 os.system("make doc -C npa >/dev/null")
 os.system("make doc -C virtualsmartcard >/dev/null")

doc/index.rst

@@ -17,6 +17,18 @@ Currently the following projects are part of vsmartcard:
    npa/README
    ccid/README
 
+.. toctree::
+   :hidden:
+
+   virtualsmartcard/autotools
+   pcsc-relay/autotools
+   npa/autotools
+   ccid/autotools
+   virtualsmartcard/questions
+   pcsc-relay/questions
+   npa/questions
+   ccid/questions
+
 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:

doc/questions.rst.in

@@ -0,0 +1,6 @@
+========
+Question
+========
+
+For questions, please use http://sourceforge.net/projects/vsmartcard/support
+

npa/doc/Makefile.am

@@ -10,7 +10,7 @@ do_subst = sed \
 	   -e 's,[@]OPENSC_LIBS[@],$(OPENSC_LIBS),g' \
 	   -e 's,[@]top_srcdir[@],$(top_srcdir),g'
 
-EXTRA_DIST = README.rst Doxyfile.in example.c autotools.rst.in
+EXTRA_DIST = README.rst Doxyfile.in example.c autotools.rst.in questions.rst.in
 
 .PHONY: doc
 doc:
@@ -18,6 +18,7 @@ doc:
 	$(DOXYGEN) Doxyfile
 	touch api.rst
 	$(do_subst) < autotools.rst.in > autotools.rst
+	$(do_subst) < questions.rst.in > questions.rst
 
 clean-local:
-	rm -f Doxyfile autotools.rst
+	rm -f Doxyfile autotools.rst questions.rst

npa/doc/README.rst

@@ -31,10 +31,6 @@ APDUs inside a secure messaging channel established with PACE.
 
 .. _npa-install:
 
-============
-Installation
-============
-
 .. include:: autotools.rst
 
 npa has the following dependencies:
@@ -93,6 +89,7 @@ configure npa to use it::
 
     ./configure OPENSC_LIBS="-L$PREFIX/lib -lopensc"
 
+
 .. _npa-usage:
 
 =====
@@ -135,10 +132,5 @@ Alternatively you can specify libraries and flags by hand::
         -I$PREFIX/include \
         -L$PREFIX/lib -lcrypto -lnpa -lopensc"
 
-=========
-Questions
-=========
-
-For questions, please use http://sourceforge.net/projects/vsmartcard/support
-
 
+.. include:: questions.rst

npa/doc/questions.rst.in

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

pcsc-relay/doc/Makefile.am

@@ -10,11 +10,12 @@ do_subst = sed \
 	   -e 's,[@]OPENSC_LIBS[@],$(OPENSC_LIBS),g' \
 	   -e 's,[@]top_srcdir[@],$(top_srcdir),g'
 
-EXTRA_DIST = README.rst autotools.rst.in
+EXTRA_DIST = README.rst autotools.rst.in questions.rst.in
 
 .PHONY: doc
 doc:
 	$(do_subst) < autotools.rst.in > autotools.rst
+	$(do_subst) < questions.rst.in > questions.rst
 
 clean-local:
-	rm -f autotools.rst
+	rm -f autotools.rst questions.rst

pcsc-relay/doc/README.rst

@@ -22,10 +22,6 @@ can use this program in combination with the virtual smart card to emulate a
 ISO/IEC 14443 smart card. 
 
 
-============
-Installation
-============
-
 .. include:: autotools.rst
 
 pcsc-relay has the following dependencies:
@@ -69,8 +65,4 @@ Winscard module. Microsoft's developement environment Visual Studio includes
 all necessary data for building pcsc-relay.
 
 
-=========
+.. include:: questions.rst
-Questions
-=========
-
-For questions, please use http://sourceforge.net/projects/vsmartcard/support

pcsc-relay/doc/questions.rst.in

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

virtualsmartcard/doc/Makefile.am

@@ -12,14 +12,15 @@ do_subst = sed \
 	   -e 's,[@]OPENSC_LIBS[@],$(OPENSC_LIBS),g' \
 	   -e 's,[@]top_srcdir[@],$(top_srcdir),g'
 
-EXTRA_DIST = README.rst autotools.rst.in
+EXTRA_DIST = README.rst autotools.rst.in questions.rst.in
 
 dist_noinst_SCRIPTS = generate_modules.py
 
 .PHONY: doc
 doc:
 	$(do_subst) < autotools.rst.in > autotools.rst
+	$(do_subst) < questions.rst.in > questions.rst
 	./generate_modules.py $(top_srcdir)/src/vpicc --dest-dir=api --suffix=rst --no-toc -1
 
 clean-local:
-	rm -rf api/* autotools.rst
+	rm -rf api/* autotools.rst questions.rst

virtualsmartcard/doc/README.rst

@@ -39,10 +39,6 @@ port 35963. The file :file:`utils.py` was taken from Henryk Plötz's
 cyberflex-shell_.
 
 
-------------
-Installation
-------------
-
 .. include:: autotools.rst
 
 Depending on your usage of the |vpicc| you might or might not need
@@ -59,9 +55,9 @@ The |vpcd| has the following dependencies:
 - PCSC-Lite_
 
 
-------------------------
+========================
 Running virtualsmartcard
-------------------------
+========================
 
 First you need to make sure that pcscd loads the |vpcd|. You might need to run
 :command:`update-reader.conf` to update pcscd's configuration file. Then
@@ -76,7 +72,4 @@ PC/SC API via |vpcd|/pcscd. You can use the opensc-explorer or pcsc_scan to test
 that.
 
 
-Question
+.. include:: questions.rst
----------
-
-For questions, please use http://sourceforge.net/projects/vsmartcard/support

virtualsmartcard/doc/questions.rst.in

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