PySCard (smartcard Python wrapper) API documentation update

Ludovic Rousseau

2022-12-27 09:32

The documentation for the PySCard API was not updated since 2017 (5 years ago).

epydoc → pydoctor

The tool used to generate the HTML documentation is epydoc. The latest epydoc version was released in 2008 (14 years ago). This tool is no more available in Debian so I had to move to something else.

The (new) tool to replace epydoc is pydoctor. It is actively maintained and generates nicer HTML pages.

For example, nice changes are:

use of HTML list
use syntax colorization for sample source code
provide indexes for names, classes and modules
no use of HTML frame so the URL is always correct and can be shared

Previous documentation

The old (epydoc) documentation is still available online at https://pyscard.sourceforge.io/epydoc/

New documentation

Conclusion

The new API documentation is available at https://pyscard.sourceforge.io/apidocs/index.html or from the project main documentation page https://pyscard.sourceforge.io/index.html

I guess I could improve the documentation. Feel free to report issues or suggest improvements.