==================================
sphinxcontrib-prettyspecialmethods
==================================
.. 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
Raw data
{
"_id": null,
"home_page": "https://github.com/sphinx-contrib/prettyspecialmethods",
"name": "sphinxcontrib-prettyspecialmethods",
"maintainer": "Eric Wieser",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Thomas Smith",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/43/d4/f76d1dcd4dc9c9f885cceb0d7270dd1f1f3ee71f838bd486f7eeb7b4c9da/sphinxcontrib-prettyspecialmethods-0.1.0.tar.gz",
"platform": "",
"description": "==================================\nsphinxcontrib-prettyspecialmethods\n==================================\n\n.. image:: https://travis-ci.org/sphinx-contrib/prettyspecialmethods.svg?branch=master\n :target: https://travis-ci.org/sphinx-contrib/prettyspecialmethods\n\nShows special methods as the python syntax that invokes them\n\nOverview\n--------\n\nThis module renders docs like\n\n.. code-block:: rst\n\n .. method:: __add__(other)\n Docstring\n\n\nas\n\nself + other\n Docstring\n\n\nAfter installing this module, add the following to your `conf.py` to enable it\n\n.. code-block:: python\n\n extensions = [\n ... # your other extensions\n 'sphinxcontrib.prettyspecialmethods',\n ]\n\n\nLinks\n-----\n\n- Source: https://github.com/sphinx-contrib/prettyspecialmethods\n- Bugs: https://github.com/sphinx-contrib/prettyspecialmethods/issues",
"bugtrack_url": null,
"license": "",
"summary": "Shows special methods as the python syntax that invokes them",
"version": "0.1.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "43d4f76d1dcd4dc9c9f885cceb0d7270dd1f1f3ee71f838bd486f7eeb7b4c9da",
"md5": "8acba0336a0eba316c0db874bce60f27",
"sha256": "46acdd19a6d8aa79a1c9b3fc5b9d6bd46ed36e10d018dc3e7b84f7ad54d49d45"
},
"downloads": -1,
"filename": "sphinxcontrib-prettyspecialmethods-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "8acba0336a0eba316c0db874bce60f27",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9014,
"upload_time": "2020-06-21T11:55:56",
"upload_time_iso_8601": "2020-06-21T11:55:56.222231Z",
"url": "https://files.pythonhosted.org/packages/43/d4/f76d1dcd4dc9c9f885cceb0d7270dd1f1f3ee71f838bd486f7eeb7b4c9da/sphinxcontrib-prettyspecialmethods-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-06-21 11:55:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "sphinx-contrib",
"github_project": "prettyspecialmethods",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "pbr",
"specs": []
},
{
"name": "sphinx",
"specs": []
}
],
"tox": true,
"lcname": "sphinxcontrib-prettyspecialmethods"
}
JSON
