{"id":25139568,"url":"https://github.com/BasicWolf/sphinx-testify","last_synced_at":"2025-10-23T15:31:07.147Z","repository":{"id":263146777,"uuid":"875214150","full_name":"BasicWolf/sphinx-testify","owner":"BasicWolf","description":"Testified Documentation plugin for Sphinx","archived":false,"fork":false,"pushed_at":"2025-02-05T09:07:18.000Z","size":122,"stargazers_count":6,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-05T10:22:13.226Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BasicWolf.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"COPYING","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":"2024-10-19T11:49:21.000Z","updated_at":"2025-02-05T09:07:21.000Z","dependencies_parsed_at":"2024-11-16T15:17:41.129Z","dependency_job_id":"32205f31-3b1e-460a-b4b2-e28239733698","html_url":"https://github.com/BasicWolf/sphinx-testify","commit_stats":null,"previous_names":["basicwolf/sphinx-testify"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BasicWolf%2Fsphinx-testify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BasicWolf%2Fsphinx-testify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BasicWolf%2Fsphinx-testify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BasicWolf%2Fsphinx-testify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BasicWolf","download_url":"https://codeload.github.com/BasicWolf/sphinx-testify/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237847060,"owners_count":19375659,"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":[],"created_at":"2025-02-08T18:01:13.543Z","updated_at":"2025-10-23T15:31:06.738Z","avatar_url":"https://github.com/BasicWolf.png","language":"Python","funding_links":[],"categories":["Testing Frameworks"],"sub_categories":[],"readme":"![Build](https://github.com/basicwolf/sphinx-testify/actions/workflows/ci.yml/badge.svg)\n\n# Sphinx-testify\n\nsphinx-testify is an extension to the Sphinx documentation generator,\nthat enables building [testified documentation][] and, ultimately\n[living documentation][].\n\n[testified documentation]: https://sphinx-testify.readthedocs.io/en/latest/testified-documentation.html\n[living documentation]: https://gojko.net/books/specification-by-example/\n\n## Testified documentation in a nutshell\n\nTestified documentation means that the documentation source references test\nresults, and these references are verified during the build process.\nAs a result, we can keep every paragraph even every sentence of\nthe documentation aligned with the code, as long as there is a test\nthat \"testifies\" the described behaviour.\n\n\n## A simple example\n\nImagine you're working on a system access module.\nEven *before* writing any tests or code, you can briefly document\nthe expected behavior and reference the (to-be-created) tests.\nProceed with a TDD cycle, and once all the tests and implementation\nare ready, you’ll have testified and living documentation.\n\nHere's how it looks like in a reStructuredText document:\n\n```rst\n\n   System access\n   =============\n\n   Users with valid credentials: a username and a password can access\n   the system. If credentials are wrong, the system returns \"Authentication failed\"\n   error message.\n\n   .. testify::\n      test_a_user_can_access_system_with_username_and_password\n      test_system_returns_authentication_failed_error_when_username_is_not_found\n      test_system_returns_authentication_failed_error_when_password_is_wrong\n```\n\n## A full example\n\nYou practice what you preach. It would be hypocritical to develop sphinx-testify\nin a way different from what is described above.\nIn short, the documentation to the library itself is testified!\nEverything you need for a real-world example is here, in the repository :)\n\n## Installation\n\n```shell\npip install sphinx-testify\n```\n\n## Links\n\nCode: https://github.com/BasicWolf/sphinx-testify\n\u003cbr\u003e\nDocs: https://sphinx-testify.readthedocs.io/en/latest/\n\n## License\n\nGPLv3\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBasicWolf%2Fsphinx-testify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBasicWolf%2Fsphinx-testify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBasicWolf%2Fsphinx-testify/lists"}