{"id":19400272,"url":"https://github.com/vhiribarren/sphinxcontrib-itemlist","last_synced_at":"2026-02-07T18:31:27.791Z","repository":{"id":57469908,"uuid":"466834614","full_name":"vhiribarren/sphinxcontrib-itemlist","owner":"vhiribarren","description":"Sphinx extension to create a table or column of declared items","archived":false,"fork":false,"pushed_at":"2022-03-15T19:50:39.000Z","size":34,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-31T10:59:09.270Z","etag":null,"topics":["documentation","python","python3","sphinx","sphinx-extension"],"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/vhiribarren.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-03-06T19:25:08.000Z","updated_at":"2025-02-20T18:30:19.000Z","dependencies_parsed_at":"2022-09-19T10:20:59.347Z","dependency_job_id":null,"html_url":"https://github.com/vhiribarren/sphinxcontrib-itemlist","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/vhiribarren/sphinxcontrib-itemlist","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vhiribarren%2Fsphinxcontrib-itemlist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vhiribarren%2Fsphinxcontrib-itemlist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vhiribarren%2Fsphinxcontrib-itemlist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vhiribarren%2Fsphinxcontrib-itemlist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vhiribarren","download_url":"https://codeload.github.com/vhiribarren/sphinxcontrib-itemlist/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vhiribarren%2Fsphinxcontrib-itemlist/sbom","scorecard":{"id":919698,"data":{"date":"2025-08-11","repo":{"name":"github.com/vhiribarren/sphinxcontrib-itemlist","commit":"a75c8765bb178526a7b506a1218abd59d19859d1"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","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":"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":"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":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"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":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","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":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"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":"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":"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":"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":"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 'main'"],"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"}}]},"last_synced_at":"2025-08-25T00:36:29.401Z","repository_id":57469908,"created_at":"2025-08-25T00:36:29.401Z","updated_at":"2025-08-25T00:36:29.401Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29203782,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-07T17:44:10.191Z","status":"ssl_error","status_checked_at":"2026-02-07T17:44:07.936Z","response_time":63,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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","python3","sphinx","sphinx-extension"],"created_at":"2024-11-10T11:13:33.749Z","updated_at":"2026-02-07T18:31:27.778Z","avatar_url":"https://github.com/vhiribarren.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sphinxcontrib-itemlist\n\nSphinx extension to create a list or table of different items marked with a\nspecial `.. item::` directive.\n\nThis extension is quite similar to the `.. contents::` directive, since its\npurpose is to create a list of shortcuts to different targets.\n\nThe main differences with `contents` are:\n\n- possibility to create a summary table or a list, not only a list\n- not restricted to list sections, so not necessary to artifically create sections\n\n## Usage\n\nSome examples are in the `demo/` folder.\n\nItems you want to be referenced in a list or table must use the `.. item::` directive:\n\n    .. item:: This is an Item title\n\n        This is the long description of the Item.\n\n        :Tag: Arbitrary tag\n        :Category: My arbitrary category \n\nThe field list can be used when generating a table to add extra columns with their contents.\n\nAll `item` of a page can then be collected.\n\nFor a list:\n\n    .. item_list::\n\nFor a table:\n\n    .. item_table::\n\n### List options\n\n- `:numbered:` uses numbers instead of bullet points\n- `:local:` instead of collecting `item` from all the page, only collect the ones from the current section\n\nExample with all options:\n\n    .. item_list::\n        :numbered:\n        :local:\n\n### Table options\n\n- `:local:` instead of collecting `item` from all the page, only collect the ones from the current section\n- `:headers:` which columns to add to the table ; the fields added in the `item` are used for that,\n  separated with a comma\n- `:desc_name:` set a title for the column containing the first line of the `item` directive ; once set, it can be\n  used in the `:headers:` option to organize the column order\n\nExample with all options:\n\n    .. item_table::\n        :local:\n        :headers: Tag, Description, Category\n        :desc_name: Description\n\n### Default fields\n\nWhen used with the table, it is possible to add implicit fields with `item`, when a success of `item` should\nhave some common fields. To introduce a new scope with default fields:\n\n    .. item_default_fields::\n\n        :Tag: Default tag\n\nTo stop adding a default field, just create a new scope with any fields:\n\n    .. item_default_fields::\n\nCaveat: when defining default fields, there must be a new line between the directive and the field list. Otherwise\nthere are considered options of the directive.\n\nPossible options:\n\n- `:hidden:` Does not add the default fields in the `item`` only in the table.\n\nExample with option and default fields:\n\n    .. item_default_fields::\n        :hidden:\n\n        :Tag: Default tag\n\n\n## Installation\n\n    $ pip install sphinxcontrib-itemlist\n\nThen add in your Sphinx `conf.py` file:\n\n    extensions = [ \"sphinxcontrib.itemlist\" ]\n\n## Alternatives\n\nSome alternatives I found:\n\n- [sphinxcontrib-needs](https://sphinxcontrib-needs.readthedocs.io)\n    - missed it at first look, not referenced in official ``contrib`` repository\n    - too heavyweight for my needs\n\n- [sphinxcontrib-requirements](https://github.com/sphinx-contrib/requirements)\n    - goal and result is a bit different, too specific","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvhiribarren%2Fsphinxcontrib-itemlist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvhiribarren%2Fsphinxcontrib-itemlist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvhiribarren%2Fsphinxcontrib-itemlist/lists"}