Shows special methods as the python syntax that invokes them
Project Links
Meta
Author: Thomas Smith
Maintainer: Eric Wieser
Classifiers
Development Status
- 3 - Alpha
Environment
- Console
- Web Environment
Framework
- Sphinx :: Extension
Intended Audience
- Developers
License
- OSI Approved :: MIT License
Operating System
- OS Independent
Programming Language
- Python
- Python :: 3
- Python :: 3.6
- Python :: 3.7
- Python :: 3.8
- Python :: 3.9
Topic
- Documentation
- Documentation :: Sphinx
- Utilities
Shows special methods as the python syntax that invokes them
Overview
This module renders docs like
.. method:: __add__(other)
Docstringas
- self + other
Docstring
After installing this module, add the following to your conf.py to enable it
extensions = [
... # your other extensions
'sphinxcontrib.prettyspecialmethods',
]Links
Files in release
No dependencies