Bug#881558: python-rtslib-fb: Please migrate away from Epydoc if possible
On Tue, Mar 26, 2019, 09:18 Thomas Goirand wrote: > Hi, > > Could you explain again how to fix? Maybe you can provide a patch for > this package? I'd like to fix this right after Buster, to get rid of all > traces of Python 2. > There's no general solution. Someone needs to review the existing code documentation, convert it to some other format, and stop using Epydoc. (Or simply stop generating API documentation at all.) In my original bug report, I provided a link to the converter script that I used in my own code, which offers a starting point for one kind of solution (converting Epydoc markup to Google-style docstrings). However, there are dozens of packages that depend on Epydoc, and they are all different, so I'm not capable of providing a patch or specific instructions. KEN >
Bug#881558: python-rtslib-fb: Please migrate away from Epydoc if possible
Hi, Could you explain again how to fix? Maybe you can provide a patch for this package? I'd like to fix this right after Buster, to get rid of all traces of Python 2. Cheers, Thomas Goirand (zigo)
Bug#881558: python-rtslib-fb: Please migrate away from Epydoc if possible
Source: python-rtslib-fb Severity: wishlist Hi, If possible, please consider moving away from the use of Epydoc in your package. 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 (or your upstream) 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. Thanks, Ken (maintainer for python-epydoc) [1] https://bitbucket.org/cedarsolutions/cedar-backup3/src/73037a2/util/sphinx-convert
