{"id":23229653,"url":"https://github.com/thomashickman/python-docs-opener","last_synced_at":"2025-04-05T18:31:36.779Z","repository":{"id":45018450,"uuid":"415279109","full_name":"ThomasHickman/python-docs-opener","owner":"ThomasHickman","description":"VS code extension to open documentation for the current symbol under the cursor in the default web browser","archived":false,"fork":false,"pushed_at":"2024-11-09T20:10:52.000Z","size":46184,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-11T15:56:37.108Z","etag":null,"topics":["documentation","extension","vscode"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/ThomasHickman.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-09T10:41:11.000Z","updated_at":"2024-11-09T20:10:55.000Z","dependencies_parsed_at":"2024-11-09T20:34:00.882Z","dependency_job_id":null,"html_url":"https://github.com/ThomasHickman/python-docs-opener","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/ThomasHickman%2Fpython-docs-opener","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThomasHickman%2Fpython-docs-opener/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThomasHickman%2Fpython-docs-opener/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThomasHickman%2Fpython-docs-opener/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ThomasHickman","download_url":"https://codeload.github.com/ThomasHickman/python-docs-opener/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247383789,"owners_count":20930346,"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":["documentation","extension","vscode"],"created_at":"2024-12-19T01:18:41.077Z","updated_at":"2025-04-05T18:31:36.761Z","avatar_url":"https://github.com/ThomasHickman.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# python-docs-opener\n\nVS code extension to open documentation for the current symbol under the cursor in the default web browser.\n\n![Screen recording of python-docs-opener in action](static/screen-recording.gif)\n\n## Requirements\n\n- python \u003e= 3.6\n- [virtualenv](https://virtualenv.pypa.io/en/latest/installation.html)\n\n## Commands\n\nTo open the current open documentation for the current symbol under the cursor in the web browser, either press \u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eShift\u003c/kbd\u003e + \u003ckbd\u003eP\u003c/kbd\u003e and search for `Python Docs Opener`, or use the keyboard shortcut \u003ckbd\u003eShift\u003c/kbd\u003e + \u003ckbd\u003eF1\u003c/kbd\u003e.\n\n## Opening documentation from non-builtin Python libraries\n\nYou can use the setting `additionalLibraryToDocsMappings` to specify documentation for third party libraries. The variable `${symbol_name}` can be used to specify the symbol. For example, to specify the documentation for pytest, add the following setting:\n\n```javascript\n\"pythonDocsOpener.additionalLibraryToDocsMappings\": {\n    \"pytest\": \"https://docs.pytest.org/en/6.2.x/reference.html#${symbol_name}\"\n}\n```\n\n## Development\n### Running tests\n\nTo run the tests, first create a virtual environment with `jedi~=0.18` installed it it:\n```\n$ virtualenv venv\ncreated virtual environment CPython3.12.5.final.0-64 in 116ms\n  creator CPython3Posix(dest=/home/user/python-docs-opener/venv, clear=False, no_vcs_ignore=False, global=False)\n  seeder FromAppData(download=False, pip=bundle, via=copy, app_data_dir=/home/user/.local/share/virtualenv)\n    added seed packages: pip==24.0\n  activators BashActivator,CShellActivator,FishActivator,NushellActivator,PowerShellActivator,PythonActivator\n$ pip install jedi~=0.18\nCollecting jedi~=0.18\n  Using cached jedi-0.19.1-py2.py3-none-any.whl.metadata (22 kB)\nCollecting parso\u003c0.9.0,\u003e=0.8.3 (from jedi~=0.18)\n  Using cached parso-0.8.4-py2.py3-none-any.whl.metadata (7.7 kB)\nUsing cached jedi-0.19.1-py2.py3-none-any.whl (1.6 MB)\nUsing cached parso-0.8.4-py2.py3-none-any.whl (103 kB)\nInstalling collected packages: parso, jedi\nSuccessfully installed jedi-0.19.1 parso-0.8.4\n```\nThen run `npm test`","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthomashickman%2Fpython-docs-opener","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthomashickman%2Fpython-docs-opener","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthomashickman%2Fpython-docs-opener/lists"}