LudovicRousseau / pyscard

pyscard smartcard library for python
http://pyscard.sourceforge.net/
GNU Lesser General Public License v2.1
383 stars 110 forks source link

Move from Epydoc to Sphinx #61

Closed LudovicRousseau closed 6 years ago

LudovicRousseau commented 6 years ago

From epydoc Debian package:

epydoc (3.0.1+dfsg-16) unstable; urgency=medium

If possible, please consider moving away from the use of Epydoc. Epydoc is basically unmaintained upstream. Also, it is only supported for Python 2, so it will reach its end of life along with Python 2 sometime in 2020.

I will continue to maintain the Epydoc packages in Debian as long as I can, acting as de facto upstream. However, once Python 2 is unsupported in Debian, I'm not sure that we'll have too many options to keep it alive. Migrating it to Python 3 is a fairly large job that I don't have the time or the expertise to take on right now.

For my own Python code, I have recently converted to Sphinx using the Napolean plugin. At [1], I can offer you a hack-ish script to convert common Epydoc markup to Google-style docstrings. It's not perfect, but it would get you much of the way toward working code.

[1] https://bitbucket.org/cedarsolutions/cedar-backup3/src/73037a2/util/sphinx-convert

-- Kenneth J. Pronovici pronovic@debian.org Sun, 12 Nov 2017 20:39:48 +0000

LudovicRousseau commented 6 years ago

Done.