{"id":19931040,"url":"https://github.com/sphinx-contrib/prettyspecialmethods","last_synced_at":"2025-05-03T10:32:21.161Z","repository":{"id":54171889,"uuid":"268816391","full_name":"sphinx-contrib/prettyspecialmethods","owner":"sphinx-contrib","description":"Shows special/magic methods in sphinx docs as the python syntax that invokes them","archived":false,"fork":false,"pushed_at":"2023-03-27T20:56:57.000Z","size":31,"stargazers_count":5,"open_issues_count":11,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-07T15:01:32.551Z","etag":null,"topics":["magic-methods","python","sphinx","sphinx-extension","sphinxcontrib"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sphinx-contrib.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-02T13:59:37.000Z","updated_at":"2024-01-28T22:17:31.000Z","dependencies_parsed_at":"2022-08-13T08:20:14.898Z","dependency_job_id":null,"html_url":"https://github.com/sphinx-contrib/prettyspecialmethods","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fprettyspecialmethods","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fprettyspecialmethods/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fprettyspecialmethods/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fprettyspecialmethods/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sphinx-contrib","download_url":"https://codeload.github.com/sphinx-contrib/prettyspecialmethods/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250580709,"owners_count":21453531,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["magic-methods","python","sphinx","sphinx-extension","sphinxcontrib"],"created_at":"2024-11-12T23:05:54.653Z","updated_at":"2025-05-03T10:32:20.889Z","avatar_url":"https://github.com/sphinx-contrib.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"==================================\nsphinxcontrib-prettyspecialmethods\n==================================\n\n|badge-pypi| |badge-travis|\n\n.. |badge-pypi| image:: https://badgen.net/pypi/v/sphinxcontrib-prettyspecialmethods\n    :target: https://pypi.org/project/sphinxcontrib-prettyspecialmethods\n\n.. |badge-travis| 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\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Fprettyspecialmethods","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsphinx-contrib%2Fprettyspecialmethods","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Fprettyspecialmethods/lists"}