{"id":13557244,"url":"https://github.com/executablebooks/sphinx-togglebutton","last_synced_at":"2026-01-16T11:53:42.107Z","repository":{"id":41161685,"uuid":"232645150","full_name":"executablebooks/sphinx-togglebutton","owner":"executablebooks","description":"Show and hide content with a button in Sphinx","archived":false,"fork":false,"pushed_at":"2026-01-14T14:32:51.000Z","size":801,"stargazers_count":47,"open_issues_count":14,"forks_count":17,"subscribers_count":6,"default_branch":"master","last_synced_at":"2026-01-14T17:34:48.748Z","etag":null,"topics":["jupyter-book","sphinx","sphinx-doc","sphinx-extension"],"latest_commit_sha":null,"homepage":"https://sphinx-togglebutton.readthedocs.io/en/latest/","language":"JavaScript","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/executablebooks.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-01-08T19:46:56.000Z","updated_at":"2026-01-14T14:32:51.000Z","dependencies_parsed_at":"2023-11-23T19:55:28.551Z","dependency_job_id":"8d8bee5e-633f-4b4d-a25a-913bdf94c9a0","html_url":"https://github.com/executablebooks/sphinx-togglebutton","commit_stats":{"total_commits":60,"total_committers":5,"mean_commits":12.0,"dds":0.09999999999999998,"last_synced_commit":"d6bbae620cc4d92220a260fca75da66ed71e4e72"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/executablebooks/sphinx-togglebutton","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executablebooks%2Fsphinx-togglebutton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executablebooks%2Fsphinx-togglebutton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executablebooks%2Fsphinx-togglebutton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executablebooks%2Fsphinx-togglebutton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/executablebooks","download_url":"https://codeload.github.com/executablebooks/sphinx-togglebutton/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executablebooks%2Fsphinx-togglebutton/sbom","scorecard":{"id":387782,"data":{"date":"2025-08-11","repo":{"name":"github.com/executablebooks/sphinx-togglebutton","commit":"f301181eba2b307340614e6c2f46a6e93153a88a"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.7,"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":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"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":"Code-Review","score":3,"reason":"Found 11/29 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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/tests.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":"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/tests.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/executablebooks/sphinx-togglebutton/tests.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/executablebooks/sphinx-togglebutton/tests.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/executablebooks/sphinx-togglebutton/tests.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/tests.yml:21","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   1 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":"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":"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":"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":"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":"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":"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":"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 25 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-18T17:05:21.986Z","repository_id":41161685,"created_at":"2025-08-18T17:05:21.986Z","updated_at":"2025-08-18T17:05:21.986Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28478391,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T06:30:42.265Z","status":"ssl_error","status_checked_at":"2026-01-16T06:30:16.248Z","response_time":107,"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":["jupyter-book","sphinx","sphinx-doc","sphinx-extension"],"created_at":"2024-08-01T12:04:14.228Z","updated_at":"2026-01-16T11:53:37.092Z","avatar_url":"https://github.com/executablebooks.png","language":"JavaScript","funding_links":[],"categories":["Python","others"],"sub_categories":[],"readme":"# sphinx-togglebutton\n\nA small sphinx extension to make it possible to add a \"toggle button\" to\nsections of your page. This allows you to:\n\n- Collapse Sphinx admonitions (notes, warnings, etc) so that their content is hidden\n  until users click a toggle button.\n- Collapse arbitrary chunks of content on your page with a `collapse` directive.\n\n![Demonstration of Sphinx Togglebutton](https://user-images.githubusercontent.com/1839645/152654312-a72a320f-e1e0-40be-95ae-3ed34facc4d3.gif)\n\n\nInstallation\n============\n\nYou can install `sphinx-togglebutton` with `pip`:\n\n```bash\npip install sphinx-togglebutton\n```\n\nUsage\n=====\n\nIn your `conf.py` configuration file, add `sphinx_togglebutton`\nto your extensions list.\n\nE.g.:\n\n```python\nextensions = [\n    ...\n    'sphinx_togglebutton'\n    ...\n]\n```\nNow, whenever you wish for an admonition to be toggle-able, add the\n`:class: dropdown` parameter to the admonition directive that you use.\n\nFor example, this code would create a toggle-able \"note\" admonition\nthat starts hidden:\n\n```rst\n.. note::\n    :class: dropdown\n\n    This is my note.\n```\n\nClicking on the toggle button will toggle the item's visibility.\n\nYou may also **show the content by default**. To do so, add the `dropdown`\nclass *as well as* a `toggle-shown` class, like so:\n\n```rst\n.. note::\n    :class: dropdown, toggle-shown\n\n    This is my note.\n```\n\nYou can also use **containers** to add arbitrary toggle-able code. For example,\nhere's a container with an image inside:\n\n```rst\n.. container:: toggle, toggle-hidden\n\n    .. admonition:: Look at that, an image!\n\n        .. image:: https://media.giphy.com/media/mW05nwEyXLP0Y/giphy.gif\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexecutablebooks%2Fsphinx-togglebutton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexecutablebooks%2Fsphinx-togglebutton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexecutablebooks%2Fsphinx-togglebutton/lists"}