| Name | sphinx-needs JSON |
| Version |
5.0.0
JSON |
| download |
| home_page | None |
| Summary | Sphinx needs extension for managing needs/requirements and specifications |
| upload_time | 2025-02-20 10:51:14 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4,>=3.9 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
**Complete documentation**: http://sphinx-needs.readthedocs.io/en/latest/
**Attention**: ``sphinxcontrib-needs`` got renamed to ``sphinx-needs``. This affects also the URLs for documentation and repository:
* Docs: https://sphinx-needs.readthedocs.io/en/latest/
* Repo: https://github.com/useblocks/sphinx-needs
Introduction
============
``Sphinx-Needs`` allows the definition, linking and filtering of class-like need-objects, which are by default:
* requirements
* specifications
* implementations
* test cases.
This list can be easily customized via configuration (for instance to support bugs or user stories).
A default requirement need looks like:
.. image:: https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/need_1.png
:align: center
Layout and style of needs can be highly customized, so that a need can also look like:
.. image:: https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/need_2.png
:align: center
Take a look into our `Examples <https://sphinxcontrib-needs.readthedocs.io/en/latest/examples/index.html>`_ for more
pictures and ideas how to use ``Sphinx-Needs``.
For filtering and analyzing needs, ``Sphinx-Needs`` provides different, powerful possibilities:
.. list-table::
:header-rows: 1
:widths: 46,14,40
- * `needtable <https://sphinxcontrib-needs.readthedocs.io/en/latest/directives/needtable.html>`_
* `needflow <https://sphinxcontrib-needs.readthedocs.io/en/latest/directives/needflow.html>`_
* `needpie <https://sphinxcontrib-needs.readthedocs.io/en/latest/directives/needpie.html>`_
- * .. image:: https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/needtable_1.png
* .. image:: https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/needflow_1.png
* .. image:: https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/needpie_1.png
Installation
============
Using pip
---------
.. code-block:: bash
pip install sphinx-needs
If you wish to also use the plotting features of sphinx-needs (see ``needbar`` and ``needpie``), you need to also install ``matplotlib``, which is available *via* the ``plotting`` extra:
.. code-block:: bash
pip install sphinx-needs[plotting]
.. note::
Prior version **1.0.1** the package was named ``sphinxcontrib-needs``.
Using sources
-------------
.. code-block:: bash
git clone https://github.com/useblocks/sphinx-needs
cd sphinx-needs
pip install .
Activation
----------
For final activation, please add `sphinx_needs` to the project's extension list of your **conf.py** file.
.. code-block:: python
extensions = ["sphinx_needs",]
.. note::
Prior version **1.0.1** the extensions was called ``sphinxcontrib.needs``.
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-needs",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "team useblocks <info@useblocks.com>",
"download_url": "https://files.pythonhosted.org/packages/16/03/291361ea1adb0d4ed5b841a154a54cf67816e7c54dec810f6e3389a48562/sphinx_needs-5.0.0.tar.gz",
"platform": null,
"description": "**Complete documentation**: http://sphinx-needs.readthedocs.io/en/latest/\n\n**Attention**: ``sphinxcontrib-needs`` got renamed to ``sphinx-needs``. This affects also the URLs for documentation and repository:\n\n* Docs: https://sphinx-needs.readthedocs.io/en/latest/\n* Repo: https://github.com/useblocks/sphinx-needs\n\n\nIntroduction\n============\n\n``Sphinx-Needs`` allows the definition, linking and filtering of class-like need-objects, which are by default:\n\n* requirements\n* specifications\n* implementations\n* test cases.\n\nThis list can be easily customized via configuration (for instance to support bugs or user stories).\n\nA default requirement need looks like:\n\n.. image:: https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/need_1.png\n :align: center\n\nLayout and style of needs can be highly customized, so that a need can also look like:\n\n.. image:: https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/need_2.png\n :align: center\n\nTake a look into our `Examples <https://sphinxcontrib-needs.readthedocs.io/en/latest/examples/index.html>`_ for more\npictures and ideas how to use ``Sphinx-Needs``.\n\nFor filtering and analyzing needs, ``Sphinx-Needs`` provides different, powerful possibilities:\n\n.. list-table::\n :header-rows: 1\n :widths: 46,14,40\n\n - * `needtable <https://sphinxcontrib-needs.readthedocs.io/en/latest/directives/needtable.html>`_\n * `needflow <https://sphinxcontrib-needs.readthedocs.io/en/latest/directives/needflow.html>`_\n * `needpie <https://sphinxcontrib-needs.readthedocs.io/en/latest/directives/needpie.html>`_\n - * .. image:: https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/needtable_1.png\n * .. image:: https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/needflow_1.png\n * .. image:: https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/needpie_1.png\n\nInstallation\n============\n\nUsing pip\n---------\n\n.. code-block:: bash\n\n pip install sphinx-needs\n\nIf you wish to also use the plotting features of sphinx-needs (see ``needbar`` and ``needpie``), you need to also install ``matplotlib``, which is available *via* the ``plotting`` extra:\n\n.. code-block:: bash\n\n pip install sphinx-needs[plotting]\n\n.. note::\n\n Prior version **1.0.1** the package was named ``sphinxcontrib-needs``.\n\nUsing sources\n-------------\n\n.. code-block:: bash\n\n git clone https://github.com/useblocks/sphinx-needs\n cd sphinx-needs\n pip install .\n\n\nActivation\n----------\n\nFor final activation, please add `sphinx_needs` to the project's extension list of your **conf.py** file.\n\n.. code-block:: python\n\n extensions = [\"sphinx_needs\",]\n\n.. note::\n\n Prior version **1.0.1** the extensions was called ``sphinxcontrib.needs``.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Sphinx needs extension for managing needs/requirements and specifications",
"version": "5.0.0",
"project_urls": {
"Documentation": "https://sphinx-needs.readthedocs.io/en/latest/",
"Repository": "http://github.com/useblocks/sphinx-needs"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "826af5b46eeda9765de0d81b6196cfa0139248f8469a7546e69dff2116fe1d1b",
"md5": "e76311064f06cdef0c8f07f6af87bad7",
"sha256": "9b7b1fc4709658fe47ac7415230d07cc94748a21ab6f0df84e3263d3acb8cbe8"
},
"downloads": -1,
"filename": "sphinx_needs-5.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e76311064f06cdef0c8f07f6af87bad7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 2634630,
"upload_time": "2025-02-20T10:51:09",
"upload_time_iso_8601": "2025-02-20T10:51:09.950372Z",
"url": "https://files.pythonhosted.org/packages/82/6a/f5b46eeda9765de0d81b6196cfa0139248f8469a7546e69dff2116fe1d1b/sphinx_needs-5.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1603291361ea1adb0d4ed5b841a154a54cf67816e7c54dec810f6e3389a48562",
"md5": "88e83a818b19166a1465dbc1751e7c2c",
"sha256": "61b07e7a4efcd0d5246ed8dab699d8fe3bc794331be63ac3afa94edfcfff7572"
},
"downloads": -1,
"filename": "sphinx_needs-5.0.0.tar.gz",
"has_sig": false,
"md5_digest": "88e83a818b19166a1465dbc1751e7c2c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 27274118,
"upload_time": "2025-02-20T10:51:14",
"upload_time_iso_8601": "2025-02-20T10:51:14.579803Z",
"url": "https://files.pythonhosted.org/packages/16/03/291361ea1adb0d4ed5b841a154a54cf67816e7c54dec810f6e3389a48562/sphinx_needs-5.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-20 10:51:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "useblocks",
"github_project": "sphinx-needs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx-needs"
}
