{"library":"sphinx-needs","title":"Sphinx Needs","type":"library","description":"Sphinx Needs is a Sphinx extension for managing requirements, specifications, and other 'needs' within documentation. It allows users to define, link, filter, and visualize needs directly in reStructuredText documents. The current version is 8.0.0, and it follows a regular release cadence with major updates typically every few months and patch releases as needed.","language":"python","status":"active","last_verified":"Fri Apr 17","install":{"commands":["pip install sphinx-needs"],"cli":null},"imports":["extensions = ['sphinx_needs']"],"auth":{"required":false,"env_vars":[]},"links":{"homepage":null,"github":"http://github.com/useblocks/sphinx-needs","docs":"https://sphinx-needs.readthedocs.io/en/latest/","changelog":null,"pypi":"https://pypi.org/project/sphinx-needs/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"# conf.py\nextensions = ['sphinx_needs']\n\n# my_document.rst\n.. need:: My first requirement\n   :id: my_req_1\n   :status: open\n   :tags: example, important\n\n   This is the detailed description of my first requirement.\n","lang":"python","description":"Add 'sphinx_needs' to the `extensions` list in your Sphinx project's `conf.py` file. Then, you can define needs using the `.. need::` directive in your reStructuredText (`.rst`) documents.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}