{"id":43878730,"url":"https://github.com/sphinx-toolbox/sphinx-pyproject","last_synced_at":"2026-02-06T15:08:10.901Z","repository":{"id":38373627,"uuid":"350500478","full_name":"sphinx-toolbox/sphinx-pyproject","owner":"sphinx-toolbox","description":"Move some of your Sphinx configuration into pyproject.toml","archived":false,"fork":false,"pushed_at":"2026-01-29T13:59:32.000Z","size":308,"stargazers_count":27,"open_issues_count":5,"forks_count":7,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-01-30T03:39:34.208Z","etag":null,"topics":["documentation","pep621","python","sphinx","toml"],"latest_commit_sha":null,"homepage":"https://sphinx-pyproject.readthedocs.io/en/latest","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/sphinx-toolbox.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},"funding":{"github":["domdfcoding"]}},"created_at":"2021-03-22T21:54:57.000Z","updated_at":"2026-01-04T01:46:13.000Z","dependencies_parsed_at":"2023-10-03T04:59:45.964Z","dependency_job_id":"89ce8793-6b28-4da6-b2dc-3f2d48085c94","html_url":"https://github.com/sphinx-toolbox/sphinx-pyproject","commit_stats":{"total_commits":58,"total_committers":3,"mean_commits":"19.333333333333332","dds":"0.39655172413793105","last_synced_commit":"d47b6263ad3951a57fbc14c60802c77e729016cb"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/sphinx-toolbox/sphinx-pyproject","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-toolbox%2Fsphinx-pyproject","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-toolbox%2Fsphinx-pyproject/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-toolbox%2Fsphinx-pyproject/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-toolbox%2Fsphinx-pyproject/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sphinx-toolbox","download_url":"https://codeload.github.com/sphinx-toolbox/sphinx-pyproject/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-toolbox%2Fsphinx-pyproject/sbom","scorecard":{"id":841344,"data":{"date":"2025-08-11","repo":{"name":"github.com/sphinx-toolbox/sphinx-pyproject","commit":"76fc87066f4472ac4f278df0d9183f16e399f22b"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4,"checks":[{"name":"Maintained","score":2,"reason":"3 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/6 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":"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":"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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: topLevel 'contents' permission set to 'read': .github/workflows/conda_ci.yml:10","Info: topLevel 'contents' permission set to 'read': .github/workflows/docs_test_action.yml:13","Info: topLevel 'contents' permission set to 'read': .github/workflows/flake8.yml:14","Info: topLevel 'contents' permission set to 'read': .github/workflows/mypy.yml:14","Warn: no topLevel permission defined: .github/workflows/octocheese.yml:1","Warn: topLevel 'actions' permission set to 'write': .github/workflows/python_ci.yml:15","Info: topLevel 'contents' permission set to 'read': .github/workflows/python_ci.yml:17","Warn: topLevel 'actions' permission set to 'write': .github/workflows/python_ci_linux.yml:16","Info: topLevel 'contents' permission set to 'read': .github/workflows/python_ci_linux.yml:18","Warn: topLevel 'actions' permission set to 'write': .github/workflows/python_ci_macos.yml:15","Info: topLevel 'contents' permission set to 'read': .github/workflows/python_ci_macos.yml:17","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":"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":"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/conda_ci.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/conda_ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/conda_ci.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/conda_ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/conda_ci.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/conda_ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs_test_action.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/docs_test_action.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docs_test_action.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/docs_test_action.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docs_test_action.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/docs_test_action.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/flake8.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/flake8.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/flake8.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/flake8.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/flake8.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/flake8.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/mypy.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/mypy.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/mypy.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/mypy.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/mypy.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/mypy.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/octocheese.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/octocheese.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python_ci.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/python_ci.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python_ci.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python_ci.yml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python_ci_linux.yml:91: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci_linux.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python_ci_linux.yml:94: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci_linux.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python_ci_linux.yml:104: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci_linux.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python_ci_linux.yml:122: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci_linux.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python_ci_linux.yml:141: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci_linux.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python_ci_linux.yml:145: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci_linux.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/python_ci_linux.yml:164: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci_linux.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python_ci_linux.yml:186: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci_linux.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python_ci_linux.yml:189: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci_linux.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/python_ci_linux.yml:194: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci_linux.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python_ci_linux.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci_linux.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/python_ci_linux.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci_linux.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python_ci_linux.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci_linux.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python_ci_linux.yml:78: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci_linux.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python_ci_macos.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci_macos.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/python_ci_macos.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci_macos.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python_ci_macos.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci_macos.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python_ci_macos.yml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-toolbox/sphinx-pyproject/python_ci_macos.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/flake8.yml:45","Warn: pipCommand not pinned by hash: .github/workflows/flake8.yml:46","Warn: pipCommand not pinned by hash: .github/workflows/mypy.yml:49","Warn: pipCommand not pinned by hash: .github/workflows/mypy.yml:50","Warn: pipCommand not pinned by hash: .github/workflows/python_ci_linux.yml:69","Warn: pipCommand not pinned by hash: .github/workflows/python_ci_linux.yml:70","Warn: pipCommand not pinned by hash: .github/workflows/python_ci_linux.yml:71","Warn: pipCommand not pinned by hash: .github/workflows/python_ci_linux.yml:100","Warn: pipCommand not pinned by hash: .github/workflows/python_ci_linux.yml:101","Warn: pipCommand not pinned by hash: .github/workflows/python_ci_linux.yml:153","Warn: pipCommand not pinned by hash: .github/workflows/python_ci_linux.yml:154","Warn: pipCommand not pinned by hash: .github/workflows/python_ci_linux.yml:173","Warn: pipCommand not pinned by hash: .github/workflows/python_ci_linux.yml:206","Warn: pipCommand not pinned by hash: .github/workflows/python_ci_linux.yml:207","Warn: pipCommand not pinned by hash: .github/workflows/python_ci_macos.yml:68","Warn: pipCommand not pinned by hash: .github/workflows/python_ci_macos.yml:69","Info:   0 out of  24 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of  11 third-party GitHubAction dependencies pinned","Info:   0 out of  16 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":"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":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v0.3.0 not signed: https://api.github.com/repos/sphinx-toolbox/sphinx-pyproject/releases/117866347","Warn: release artifact v0.2.0 not signed: https://api.github.com/repos/sphinx-toolbox/sphinx-pyproject/releases/117866349","Warn: release artifact v0.1.0 not signed: https://api.github.com/repos/sphinx-toolbox/sphinx-pyproject/releases/40933925","Warn: release artifact v0.3.0 does not have provenance: https://api.github.com/repos/sphinx-toolbox/sphinx-pyproject/releases/117866347","Warn: release artifact v0.2.0 does not have provenance: https://api.github.com/repos/sphinx-toolbox/sphinx-pyproject/releases/117866349","Warn: release artifact v0.1.0 does not have provenance: https://api.github.com/repos/sphinx-toolbox/sphinx-pyproject/releases/40933925"],"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":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"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":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/python_ci_linux.yml:135"],"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 24 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-23T20:33:14.913Z","repository_id":38373627,"created_at":"2025-08-23T20:33:14.913Z","updated_at":"2025-08-23T20:33:14.913Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29165908,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-06T14:37:12.680Z","status":"ssl_error","status_checked_at":"2026-02-06T14:36:22.973Z","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","pep621","python","sphinx","toml"],"created_at":"2026-02-06T15:08:10.318Z","updated_at":"2026-02-06T15:08:10.894Z","avatar_url":"https://github.com/sphinx-toolbox.png","language":"Python","funding_links":["https://github.com/sponsors/domdfcoding"],"categories":[],"sub_categories":[],"readme":"#################\nsphinx-pyproject\n#################\n\n.. start short_desc\n\n**Move some of your Sphinx configuration into pyproject.toml**\n\n.. end short_desc\n\n\n.. start shields\n\n.. list-table::\n\t:stub-columns: 1\n\t:widths: 10 90\n\n\t* - Docs\n\t  - |docs| |docs_check|\n\t* - Tests\n\t  - |actions_linux| |actions_windows| |actions_macos| |coveralls|\n\t* - PyPI\n\t  - |pypi-version| |supported-versions| |supported-implementations| |wheel|\n\t* - Anaconda\n\t  - |conda-version| |conda-platform|\n\t* - Activity\n\t  - |commits-latest| |commits-since| |maintained| |pypi-downloads|\n\t* - QA\n\t  - |codefactor| |actions_flake8| |actions_mypy|\n\t* - Other\n\t  - |license| |language| |requires|\n\n.. |docs| image:: https://img.shields.io/readthedocs/sphinx-pyproject/latest?logo=read-the-docs\n\t:target: https://sphinx-pyproject.readthedocs.io/en/latest\n\t:alt: Documentation Build Status\n\n.. |docs_check| image:: https://github.com/sphinx-toolbox/sphinx-pyproject/workflows/Docs%20Check/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-pyproject/actions?query=workflow%3A%22Docs+Check%22\n\t:alt: Docs Check Status\n\n.. |actions_linux| image:: https://github.com/sphinx-toolbox/sphinx-pyproject/workflows/Linux/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-pyproject/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/sphinx-toolbox/sphinx-pyproject/workflows/Windows/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-pyproject/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/sphinx-toolbox/sphinx-pyproject/workflows/macOS/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-pyproject/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/sphinx-toolbox/sphinx-pyproject/workflows/Flake8/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-pyproject/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/sphinx-toolbox/sphinx-pyproject/workflows/mypy/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-pyproject/actions?query=workflow%3A%22mypy%22\n\t:alt: mypy status\n\n.. |requires| image:: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-pyproject/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-pyproject/\n\t:alt: Requirements Status\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/sphinx-toolbox/sphinx-pyproject/master?logo=coveralls\n\t:target: https://coveralls.io/github/sphinx-toolbox/sphinx-pyproject?branch=master\n\t:alt: Coverage\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/sphinx-pyproject?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/sphinx-toolbox/sphinx-pyproject\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/sphinx-pyproject\n\t:target: https://pypi.org/project/sphinx-pyproject/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-pyproject?logo=python\u0026logoColor=white\n\t:target: https://pypi.org/project/sphinx-pyproject/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/sphinx-pyproject\n\t:target: https://pypi.org/project/sphinx-pyproject/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/sphinx-pyproject\n\t:target: https://pypi.org/project/sphinx-pyproject/\n\t:alt: PyPI - Wheel\n\n.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/sphinx-pyproject?logo=anaconda\n\t:target: https://anaconda.org/domdfcoding/sphinx-pyproject\n\t:alt: Conda - Package Version\n\n.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/sphinx-pyproject?label=conda%7Cplatform\n\t:target: https://anaconda.org/domdfcoding/sphinx-pyproject\n\t:alt: Conda - Platform\n\n.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/sphinx-pyproject\n\t:target: https://github.com/sphinx-toolbox/sphinx-pyproject/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/sphinx-pyproject\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/sphinx-pyproject/v0.3.0\n\t:target: https://github.com/sphinx-toolbox/sphinx-pyproject/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/sphinx-pyproject\n\t:target: https://github.com/sphinx-toolbox/sphinx-pyproject/commit/master\n\t:alt: GitHub last commit\n\n.. |maintained| image:: https://img.shields.io/maintenance/yes/2026\n\t:alt: Maintenance\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/sphinx-pyproject\n\t:target: https://pypistats.org/packages/sphinx-pyproject\n\t:alt: PyPI - Downloads\n\n.. end shields\n\nInstallation\n--------------\n\n.. start installation\n\n``sphinx-pyproject`` can be installed from PyPI or Anaconda.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install sphinx-pyproject\n\nTo install with ``conda``:\n\n\t* First add the required channels\n\n\t.. code-block:: bash\n\n\t\t$ conda config --add channels https://conda.anaconda.org/conda-forge\n\t\t$ conda config --add channels https://conda.anaconda.org/domdfcoding\n\n\t* Then install\n\n\t.. code-block:: bash\n\n\t\t$ conda install sphinx-pyproject\n\n.. end installation\n\nUsage\n-------\n\nThe ``SphinxConfig`` class will load the configuration from ``pyproject.toml``.\nBy passing ``globalns=globals()`` to the class constructor, the keys parsed from the\n``pyproject.toml`` file will be added to the global namespace of the ``conf.py`` file.\n\nFor example:\n\n.. code-block:: python3\n\n\t# conf.py\n\n\tfrom sphinx_pyproject import SphinxConfig\n\n\tconfig = SphinxConfig(\"../pyproject.toml\", globalns=globals())\n\n\tauthor  # This name *looks* to be undefined, but it isn't.\n\nThe ``SphinxConfig`` class also provides a ``collections.abc.Mapping`` interface.\nIf you are going to override or modify one of the configuration values after parsing it,\nthe recommended approach is to explicitly assign the name:\n\n.. code-block:: python\n\n\textensions = config[\"extensions\"]\n\textensions.append(\"sphinx.ext.autodoc\")\n\nThis will prevent warnings from linters etc., but is not necessary for Sphinx to see the configuration.\n\nAdditionally the ``SphinxConfig`` class takes an optional parameter ``config_overrides`` that\ncan be used to dynamically update values from ``pyproject.toml``. This can be helpful for setting\ndynamic values like ``version``.\n\n.. code-block:: python3\n\n\t# conf.py\n\tfrom sphinx_pyproject import SphinxConfig\n\n\tfrom myproject import __version__ as myproject_version\n\n\tconfig = SphinxConfig(\"../pyproject.toml\", globalns=globals(), config_overrides = {\"version\": myproject_version})\n\n\nConfiguration\n^^^^^^^^^^^^^^^\n\n``sphinx-pyproject`` parses the configuration from the ``[project]`` and ``[tool.sphinx-pyproject]`` tables in ``pyproject.toml``.\nThe ``[project]`` table is defined in `PEP 621`_.\n``sphinx-pyproject`` only uses the following keys:\n\n* name_ – The name of the project.\n* version_ – The version of the project.\n* description_ – The summary description of the project.\n* One of `authors/maintainers`_.\n\nThe remaining `Sphinx configuration values`_ can be provided in the ``[tool.sphinx-pyproject]`` table.\n\nSee `this project's pyproject.toml file`_ for an example of this configuration.\n\n.. _PEP 621: https://www.python.org/dev/peps/pep-0621/#authors-maintainers\n.. _name: https://www.python.org/dev/peps/pep-0621/#name\n.. _version: https://www.python.org/dev/peps/pep-0621/#version\n.. _description: https://www.python.org/dev/peps/pep-0621/#description\n.. _authors/maintainers: https://www.python.org/dev/peps/pep-0621/#authors-maintainers\n.. _Sphinx configuration values: https://www.sphinx-doc.org/en/master/usage/configuration.html\n.. _this project's pyproject.toml file: https://github.com/sphinx-toolbox/sphinx-pyproject/blob/master/pyproject.toml\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-toolbox%2Fsphinx-pyproject","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsphinx-toolbox%2Fsphinx-pyproject","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-toolbox%2Fsphinx-pyproject/lists"}