VivoKey/vsmartcard
7
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

respect sphinx style guide to some extent

Browse Source 
see http://documentation-style-guide-sphinx.readthedocs.org/en/latest/style-guide.html
This commit is contained in:
Frank Morgner
2013-03-05 20:42:09 +01:00
parent 9be74c7886
commit 37e5f9d514
74 changed files with 488 additions and 264 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
npa/README
View File

@@ -1 +1 @@
doc/README.rst
doc/README.txt

12
npa/doc/Makefile.am
View File

@@ -16,18 +16,18 @@ 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 Doxyfile.in example.c autotools.rst autotools.rst.in questions.rst questions.rst.in download.rst.in download.rst
EXTRA_DIST = README.txt.in README.txt Doxyfile.in example.c autotools.txt autotools.txt.in questions.txt questions.txt.in download.txt.in download.txt
DOXYGEN = doxygen
doc: $(top_srcdir)/src/npa/*.h *.in
$(do_subst) < Doxyfile.in > Doxyfile
$(DOXYGEN) Doxyfile
touch api.rst
$(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
touch api.txt
$(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
touch doc
clean-local:

43
npa/doc/README.rst → npa/doc/README.txt
View File

@@ -1,18 +1,14 @@
.. highlight:: sh
.. _OpenSC: https://github.com/OpenSC/OpenSC
.. _OpenSSL: http://www.openssl.org
.. _OpenPACE: http://openpace.sourceforge.net
.. |PACE| replace:: :abbr:`PACE (Password Authenticated Connection Establishment)`
.. |npa-tool| replace:: :command:`npa-tool`
.. _npa:
********************************************************************************
######################
nPA Smart Card Library
********************************************************************************
######################
:Author:
Frank Morgner <morgner@informatik.hu-berlin.de>
@@ -35,12 +31,12 @@ transparent SM usage in OpenSC. This allows nPA Smart Card Library to be fully
compatible with OpenSC.
.. include:: download.rst
.. include:: download.txt
.. _npa-install:
.. include:: autotools.rst
.. include:: autotools.txt
The nPA Smart Card Library has the following dependencies:
@@ -49,9 +45,9 @@ The nPA Smart Card Library has the following dependencies:
- OpenSC_
------------------------------------
====================================
Installation of OpenPACE and OpenSSL
------------------------------------
====================================
The nPA Smart Card Library links against OpenSSL_, which must be patched for OpenPACE_.
Here is an example of how to get the standard installation of OpenPACE_ (with
@@ -69,13 +65,13 @@ the required binaries for OpenSSL)::
The file :file:`libcrypto.pc` should be located in ``$INSTALL/lib/pkgconfig``.
----------------------
======================
Installation of OpenSC
----------------------
======================
The nPA Smart Card Library need the OpenSC components to be installed (especially
:file:`libopensc.so`). Here is an example of how to get a suitable installation
of OpenSC_::
of OpenSC::
VSMARTCARD=vsmartcard
git clone git://vsmartcard.git.sourceforge.net/gitroot/vsmartcard $VSMARTCARD
@@ -88,9 +84,9 @@ of OpenSC_::
Now :file:`libopensc.so` should be located in ``$PREFIX/lib``.
--------------------------------------------------------------------------------
==========================================
Installation of the nPA Smart Card Library
--------------------------------------------------------------------------------
==========================================
To complete this step-by-step guide, here is how to install nPA Smart Card Library::
@@ -127,8 +123,8 @@ be found in :file:`apdus`.
Linking against libnpa
----------------------
Following the section `Installation`_ above, you have installed OpenSSL_,
OpenPACE_, OpenSC_ and the nPA Smart Card Library to `$PREFIX` which points to
Following the section Installation_ above, you have installed OpenSSL,
OpenPACE, OpenSC and the nPA Smart Card Library to `$PREFIX` which points to
:file:`/tmp/install`. To compile a program using nPA Smart Card Library you also need
the OpenSC header files, which are located in
:file:`$VSMARTCARD/npa/src/opensc` Here is how to compile an external program
@@ -145,4 +141,15 @@ Alternatively you can specify libraries and flags by hand::
-L$PREFIX/lib -lnpa -lopensc -lcrypto"
.. include:: questions.rst
.. include:: questions.txt
********************
Notes and References
********************
.. target-notes::
.. _OpenSC: https://github.com/OpenSC/OpenSC
.. _OpenSSL: http://www.openssl.org
.. _OpenPACE: http://openpace.sourceforge.net

63
npa/doc/README.rst.in → npa/doc/README.txt.in
View File

@@ -1,18 +1,14 @@
.. highlight:: sh
.. _OpenSC: https://github.com/OpenSC/OpenSC
.. _OpenSSL: http://www.openssl.org
.. _OpenPACE: http://openpace.sourceforge.net
.. |PACE| replace:: :abbr:`PACE (Password Authenticated Connection Establishment)`
.. |npa-tool| replace:: :command:`npa-tool`
.. _npa:
********************************************************************************
@PACKAGE_NAME@
********************************************************************************
######################
nPA Smart Card Library
######################
:Author:
Frank Morgner <morgner@informatik.hu-berlin.de>
@@ -24,36 +20,36 @@
:Potential Platforms:
Unix-like operating systems (Mac OS, Solaris, BSD, ...)
The @PACKAGE_NAME@ offers an easy to use API for the new German identity card
The nPA Smart Card Library offers an easy to use API for the new German identity card
(neuer Personalausweis, nPA). The library also implements secure messaging,
which could also be used for other cards. The included |npa-tool| can
be used for PIN management or to send APDUs inside a secure channel.
The @PACKAGE_NAME@ is implemented using OpenPACE_ and OpenSC_. @PACKAGE_NAME@
The nPA Smart Card Library is implemented using OpenPACE_ and OpenSC_. nPA Smart Card Library
implements and initializes Secure Messaging wrappers of OpenSC to allow a
transparent SM usage in OpenSC. This allows @PACKAGE_NAME@ to be fully
transparent SM usage in OpenSC. This allows nPA Smart Card Library to be fully
compatible with OpenSC.
.. include:: download.rst
.. include:: download.txt
.. _npa-install:
.. include:: autotools.rst
.. include:: autotools.txt
The @PACKAGE_NAME@ has the following dependencies:
The nPA Smart Card Library has the following dependencies:
- OpenSSL_
- OpenPACE_
- OpenSC_
------------------------------------
====================================
Installation of OpenPACE and OpenSSL
------------------------------------
====================================
The @PACKAGE_NAME@ links against OpenSSL_, which must be patched for OpenPACE_.
The nPA Smart Card Library links against OpenSSL_, which must be patched for OpenPACE_.
Here is an example of how to get the standard installation of OpenPACE_ (with
the required binaries for OpenSSL)::
@@ -69,13 +65,13 @@ the required binaries for OpenSSL)::
The file :file:`libcrypto.pc` should be located in ``$INSTALL/lib/pkgconfig``.
----------------------
======================
Installation of OpenSC
----------------------
======================
The @PACKAGE_NAME@ need the OpenSC components to be installed (especially
The nPA Smart Card Library need the OpenSC components to be installed (especially
:file:`libopensc.so`). Here is an example of how to get a suitable installation
of OpenSC_::
of OpenSC::
VSMARTCARD=vsmartcard
git clone git://vsmartcard.git.sourceforge.net/gitroot/vsmartcard $VSMARTCARD
@@ -88,11 +84,11 @@ of OpenSC_::
Now :file:`libopensc.so` should be located in ``$PREFIX/lib``.
--------------------------------------------------------------------------------
Installation of the @PACKAGE_NAME@
--------------------------------------------------------------------------------
==========================================
Installation of the nPA Smart Card Library
==========================================
To complete this step-by-step guide, here is how to install @PACKAGE_NAME@::
To complete this step-by-step guide, here is how to install nPA Smart Card Library::
cd $VSMARTCARD/npa
autoreconf --verbose --install
@@ -127,9 +123,9 @@ be found in :file:`apdus`.
Linking against libnpa
----------------------
Following the section `Installation`_ above, you have installed OpenSSL_,
OpenPACE_, OpenSC_ and the @PACKAGE_NAME@ to `$PREFIX` which points to
:file:`/tmp/install`. To compile a program using @PACKAGE_NAME@ you also need
Following the section Installation_ above, you have installed OpenSSL,
OpenPACE, OpenSC and the nPA Smart Card Library to `$PREFIX` which points to
:file:`/tmp/install`. To compile a program using nPA Smart Card Library you also need
the OpenSC header files, which are located in
:file:`$VSMARTCARD/npa/src/opensc` Here is how to compile an external program
with these libraries::
@@ -145,4 +141,15 @@ Alternatively you can specify libraries and flags by hand::
-L$PREFIX/lib -lnpa -lopensc -lcrypto"
.. include:: questions.rst
.. include:: questions.txt
********************
Notes and References
********************
.. target-notes::
.. _OpenSC: https://github.com/OpenSC/OpenSC
.. _OpenSSL: http://www.openssl.org
.. _OpenPACE: http://openpace.sourceforge.net

0
npa/doc/api.rst → npa/doc/api.txt
View File

1
npa/doc/autotools.rst.in
View File

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

4
npa/doc/autotools.rst → npa/doc/autotools.txt
View File

@@ -1,8 +1,8 @@
.. highlight:: sh
============
************
Installation
============
************
The nPA Smart Card Library 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

1
npa/doc/autotools.txt.in Symbolic link
View File

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

1
npa/doc/download.rst.in
View File

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

4
npa/doc/download.rst → npa/doc/download.txt
View File

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

1
npa/doc/download.txt.in Symbolic link
View File

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

1
npa/doc/questions.rst.in
View File

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

4
npa/doc/questions.rst → npa/doc/questions.txt
View File

@@ -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>`_.

1
npa/doc/questions.txt.in Symbolic link
View File

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