{"id":23091427,"url":"https://github.com/panda3d/sphinx-interrogatedb","last_synced_at":"2025-04-03T18:18:05.023Z","repository":{"id":57469982,"uuid":"218575359","full_name":"panda3d/sphinx-interrogatedb","owner":"panda3d","description":"Sphinx extension to enhance autodoc for interrogated modules","archived":false,"fork":false,"pushed_at":"2022-10-04T14:15:50.000Z","size":21,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-04-24T03:23:56.648Z","etag":null,"topics":["sphinx-autodoc","sphinx-extension","sphinx-interrogatedb"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/panda3d.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-30T16:41:03.000Z","updated_at":"2022-10-04T14:15:55.000Z","dependencies_parsed_at":"2022-09-19T14:36:11.946Z","dependency_job_id":null,"html_url":"https://github.com/panda3d/sphinx-interrogatedb","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/panda3d%2Fsphinx-interrogatedb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/panda3d%2Fsphinx-interrogatedb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/panda3d%2Fsphinx-interrogatedb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/panda3d%2Fsphinx-interrogatedb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/panda3d","download_url":"https://codeload.github.com/panda3d/sphinx-interrogatedb/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247052620,"owners_count":20875685,"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":["sphinx-autodoc","sphinx-extension","sphinx-interrogatedb"],"created_at":"2024-12-16T21:18:20.678Z","updated_at":"2025-04-03T18:18:04.999Z","avatar_url":"https://github.com/panda3d.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"sphinx-interrogatedb\n====================\n\nThis is a [Sphinx](https://www.sphinx-doc.org/) extension that provides\nautodoc support for modules created by interrogate, by augmenting it with\ninformation provided by interrogate databases (.in files).\n\nUsage\n-----\n\nTo make use of this extension, the following steps are needed:\n\n1. Install the module using pip.\n```\npip install sphinx-interrogatedb\n```\n2. Enable it in `conf.py`.\n```python\nextensions = ['sphinx.ext.autodoc', 'sphinx_interrogatedb']\n```\n3. Configure the search path for interrogatedb files.\n```python\ninterrogatedb_search_path = ['dir/containing/in/files/']\n```\n4. Just use autodoc, autosummary or [autopackagesummary](https://pypi.org/project/sphinx-autopackagesummary/)\nas you would normally, and the .in files will automatically be processed.\n\nConfiguration\n-------------\n\nThe following configuration options are supported:\n\n* `interrogatedb_search_path`: list of folders to search for .in files.\n* `autodoc_interrogatedb_mangle_type_names`: if True, converts type names in\n  the way that interrogate's python-native back-end does by default.\n* `autodoc_interrogatedb_mangle_type_names`: if True, converts type names from\n  snake-case to camel-case.  False by default.\n* `autodoc_interrogatedb_type_annotations`: if True, shows argument and return\n  types in function signatures using type hint syntax.  True by default.\n* `autodoc_interrogatedb_add_rtype`: if True, adds an `:rtype:` directive to\n  the bodies of docstrings with the return type.  True by default.\n\nLicense\n-------\n\nThis extension has been licensed under the terms of the Modified BSD License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpanda3d%2Fsphinx-interrogatedb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpanda3d%2Fsphinx-interrogatedb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpanda3d%2Fsphinx-interrogatedb/lists"}