Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move from Epydoc to Sphinx #61

Closed
LudovicRousseau opened this issue Jun 3, 2018 · 1 comment
Closed

Move from Epydoc to Sphinx #61

LudovicRousseau opened this issue Jun 3, 2018 · 1 comment
Assignees

Comments

@LudovicRousseau
Copy link
Owner

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
Copy link
Owner Author

Done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant