Skip to main content

Shows special methods as the python syntax that invokes them

Project description

https://travis-ci.org/sphinx-contrib/prettyspecialmethods.svg?branch=master

Shows special methods as the python syntax that invokes them

Overview

This module renders docs like

.. method:: __add__(other)
    Docstring

as

self + other

Docstring

After installing this module, add the following to your conf.py to enable it

extensions = [
    ...  # your other extensions
    'sphinxcontrib.prettyspecialmethods',
]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

File details

Details for the file sphinxcontrib-prettyspecialmethods-0.1.0.tar.gz.

File metadata

  • Download URL: sphinxcontrib-prettyspecialmethods-0.1.0.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.0

File hashes

Hashes for sphinxcontrib-prettyspecialmethods-0.1.0.tar.gz
Algorithm Hash digest
SHA256 46acdd19a6d8aa79a1c9b3fc5b9d6bd46ed36e10d018dc3e7b84f7ad54d49d45
MD5 8acba0336a0eba316c0db874bce60f27
BLAKE2b-256 43d4f76d1dcd4dc9c9f885cceb0d7270dd1f1f3ee71f838bd486f7eeb7b4c9da

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page