Actions
Idea #15015
closed
replace epydoc
Status:
Duplicate
Priority:
Normal
Assigned To:
-
Category:
Documentation
Target version:
-
Start date:
01/11/2023
Due date:
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.
Updated by Tom Morris over 5 years ago
- Related to Feature #5214: [SDKs] Use sphinx to render for Python SDK docs added
Updated by Eric Biagiotti over 5 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.
Updated by Tom Morris over 5 years ago
- Related to Support #13418: Python SDK must have docstrings for all public interfaces added
Updated by Peter Amstutz over 3 years ago
- Target version deleted (
To Be Groomed)
Updated by Brett Smith almost 2 years ago
- Status changed from New to Duplicate
We chose pdoc3. See #16833.
Updated by Brett Smith almost 2 years ago
- Related to Bug #16833: [build] replace python-epydoc in our build environment added
Actions