Story #15015
replace epydoc
Start date:
Due date:
% Done:
0%
Estimated time:
(Total: 0.00 h)
Story points:
-
Description
epydoc doesn't work with Python 3 and the last version was released a decade ago, so I think it's safe to assume that it'll never be updated.
We need to choose a different tool and switch to it.
Subtasks
Related issues
History
#1
Updated by Tom Morris about 2 years ago
- Related to Feature #5214: [SDKs] Use sphinx to render for Python SDK docs added
#2
Updated by Eric Biagiotti about 2 years ago
https://wiki.python.org/moin/DocumentationTools
reStructuredText linter - https://github.com/twolfson/restructuredtext-lint
- Consider using Sphinx and a linter to enforce a specific style.
- pdoc3 (https://pdoc3.github.io/pdoc/) is simpler and more lightweight than sphinx and can also handle reST.
- Consider using the built in pydoc and creating an internal docstring format for parameters, etc. This would be difficult to lint.
#3
Updated by Tom Morris about 2 years ago
- Related to Bug #13418: Python SDK must have docstrings for all public interfaces added
#4
Updated by Peter Amstutz over 1 year ago
- Category set to Documentation