https://github.com/sphinx-contrib/prettyspecialmethods
Shows special/magic methods in sphinx docs as the python syntax that invokes them
https://github.com/sphinx-contrib/prettyspecialmethods
magic-methods python sphinx sphinx-extension sphinxcontrib
Last synced: 7 days ago
JSON representation
Shows special/magic methods in sphinx docs as the python syntax that invokes them
- Host: GitHub
- URL: https://github.com/sphinx-contrib/prettyspecialmethods
- Owner: sphinx-contrib
- License: mit
- Created: 2020-06-02T13:59:37.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-27T20:56:57.000Z (about 2 years ago)
- Last Synced: 2025-04-07T15:01:32.551Z (about 1 month ago)
- Topics: magic-methods, python, sphinx, sphinx-extension, sphinxcontrib
- Language: Python
- Homepage:
- Size: 30.3 KB
- Stars: 5
- Watchers: 2
- Forks: 5
- Open Issues: 11
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
==================================
sphinxcontrib-prettyspecialmethods
==================================
|badge-pypi| |badge-travis|
.. |badge-pypi| image:: https://badgen.net/pypi/v/sphinxcontrib-prettyspecialmethods
:target: https://pypi.org/project/sphinxcontrib-prettyspecialmethods
.. |badge-travis| image:: https://travis-ci.org/sphinx-contrib/prettyspecialmethods.svg?branch=master
:target: https://travis-ci.org/sphinx-contrib/prettyspecialmethods
Shows special methods as the python syntax that invokes them
Overview
--------
This module renders docs like
.. code-block:: rst
.. method:: __add__(other)
Docstring
as
self + other
Docstring
After installing this module, add the following to your `conf.py` to enable it
.. code-block:: python
extensions = [
... # your other extensions
'sphinxcontrib.prettyspecialmethods',
]
Links
-----
- Source: https://github.com/sphinx-contrib/prettyspecialmethods
- Bugs: https://github.com/sphinx-contrib/prettyspecialmethods/issues