{"id":16897568,"url":"https://github.com/felix-hilden/sphinx-codeautolink","last_synced_at":"2026-04-25T16:01:13.089Z","repository":{"id":44771289,"uuid":"405966805","full_name":"felix-hilden/sphinx-codeautolink","owner":"felix-hilden","description":"Automatic links from code examples to reference documentation","archived":false,"fork":false,"pushed_at":"2026-04-25T13:29:23.000Z","size":355,"stargazers_count":71,"open_issues_count":11,"forks_count":13,"subscribers_count":3,"default_branch":"master","last_synced_at":"2026-04-25T13:31:44.174Z","etag":null,"topics":["documentation","python","sphinx","sphinx-extension"],"latest_commit_sha":null,"homepage":"https://sphinx-codeautolink.rtfd.io","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/felix-hilden.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-09-13T12:36:26.000Z","updated_at":"2026-04-25T13:29:28.000Z","dependencies_parsed_at":"2024-06-18T12:39:58.309Z","dependency_job_id":"a45e44f6-62f9-4ab8-84b6-cad102cb4923","html_url":"https://github.com/felix-hilden/sphinx-codeautolink","commit_stats":{"total_commits":182,"total_committers":5,"mean_commits":36.4,"dds":"0.038461538461538436","last_synced_commit":"6747259c952f96453b4a7a292812ebd9d608116c"},"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"purl":"pkg:github/felix-hilden/sphinx-codeautolink","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felix-hilden%2Fsphinx-codeautolink","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felix-hilden%2Fsphinx-codeautolink/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felix-hilden%2Fsphinx-codeautolink/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felix-hilden%2Fsphinx-codeautolink/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/felix-hilden","download_url":"https://codeload.github.com/felix-hilden/sphinx-codeautolink/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felix-hilden%2Fsphinx-codeautolink/sbom","scorecard":{"id":396226,"data":{"date":"2025-08-11","repo":{"name":"github.com/felix-hilden/sphinx-codeautolink","commit":"ebc9d34a685a85e0dbac95289780cba5c1b8fb57"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.1,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":3,"reason":"Found 11/30 approved changesets -- score normalized to 3","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":4,"reason":"3 commit(s) and 2 issue activity found in the last 90 days -- score normalized to 4","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/CI.yml:1","Warn: no topLevel permission defined: .github/workflows/scheduled.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/felix-hilden/sphinx-codeautolink/CI.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/felix-hilden/sphinx-codeautolink/CI.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/felix-hilden/sphinx-codeautolink/CI.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/felix-hilden/sphinx-codeautolink/CI.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/scheduled.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/felix-hilden/sphinx-codeautolink/scheduled.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/scheduled.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/felix-hilden/sphinx-codeautolink/scheduled.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/CI.yml:30","Warn: pipCommand not pinned by hash: .github/workflows/CI.yml:31","Warn: pipCommand not pinned by hash: .github/workflows/CI.yml:32","Warn: pipCommand not pinned by hash: .github/workflows/CI.yml:47","Warn: pipCommand not pinned by hash: .github/workflows/CI.yml:48","Warn: pipCommand not pinned by hash: .github/workflows/CI.yml:49","Warn: pipCommand not pinned by hash: .github/workflows/scheduled.yml:21","Warn: pipCommand not pinned by hash: .github/workflows/scheduled.yml:22","Warn: pipCommand not pinned by hash: .github/workflows/scheduled.yml:23","Info:   0 out of   6 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   9 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 16 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-18T19:05:21.730Z","repository_id":44771289,"created_at":"2025-08-18T19:05:21.730Z","updated_at":"2025-08-18T19:05:21.730Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32267710,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-25T09:15:33.318Z","status":"ssl_error","status_checked_at":"2026-04-25T09:15:31.997Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","python","sphinx","sphinx-extension"],"created_at":"2024-10-13T17:38:07.032Z","updated_at":"2026-04-25T16:01:13.043Z","avatar_url":"https://github.com/felix-hilden.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"sphinx-codeautolink\n===================\n|license| |readthedocs| |build|\n\nsphinx-codeautolink makes code examples clickable by inserting links\nfrom individual code elements to the corresponding reference documentation.\nWe aim for a minimal setup assuming your examples are already valid Python.\n\nFor a live demo, see our online documentation on\n`Read The Docs \u003chttps://sphinx-codeautolink.rtfd.org\u003e`_.\n\nsphinx-codeautolink elsewhere:\n\n- Package on `PyPI \u003chttps://pypi.org/project/sphinx-codeautolink\u003e`_\n- How to contribute on `GitHub \u003chttps://github.com/felix-hilden/\n  sphinx-codeautolink/blob/master/contributing.rst\u003e`_\n\nInstallation\n------------\n|pypi| |conda-forge|\n\nsphinx-codeautolink can be installed from the following sources:\n\n.. code:: sh\n\n    $ pip install sphinx-codeautolink\n    $ conda install -c conda-forge sphinx-codeautolink\n\nTo enable sphinx-codeautolink, modify the extension list in ``conf.py``.\nNote that the extension name uses an underscore rather than a hyphen.\n\n.. code:: python\n\n   extensions = [\n       ...,\n       \"sphinx_codeautolink\",\n   ]\n\nThat's it! Now your code examples are linked.\nFor ways of concatenating examples, setting default import statements,\nor customising link style among other things,\nsee the `online documentation \u003chttps://sphinx-codeautolink.rtfd.org\u003e`_.\n\n.. |pypi| image:: https://img.shields.io/pypi/v/sphinx-codeautolink.svg\n   :target: https://pypi.org/project/sphinx-codeautolink\n   :alt: PyPI package\n\n.. |conda-forge| image:: https://anaconda.org/conda-forge/sphinx-codeautolink/badges/version.svg\n   :target: https://anaconda.org/conda-forge/sphinx-codeautolink\n   :alt: Conda-Forge package\n\n.. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg\n   :target: https://choosealicense.com/licenses/mit\n   :alt: License: MIT\n\n.. |readthedocs| image:: https://rtfd.org/projects/sphinx-codeautolink/badge/?version=latest\n   :target: https://sphinx-codeautolink.rtfd.org/en/latest/\n   :alt: documentation\n\n.. |build| image:: https://github.com/felix-hilden/sphinx-codeautolink/workflows/CI/badge.svg\n   :target: https://github.com/felix-hilden/sphinx-codeautolink/actions\n   :alt: build status\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffelix-hilden%2Fsphinx-codeautolink","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffelix-hilden%2Fsphinx-codeautolink","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffelix-hilden%2Fsphinx-codeautolink/lists"}