sphinx-needs


Namesphinx-needs JSON
Version 1.2.0 PyPI version JSON
download
home_pagehttp://github.com/useblocks/sphinx-needs
SummarySphinx needs extension for managing needs/requirements and specifications
upload_time2023-01-25 10:40:21
maintainer
docs_urlNone
authorteam useblocks
requires_python>=3.7.0,<4.0
licenseMIT
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 poetry
------------

.. code-block:: bash

    poetry add sphinx-needs

Using pip
---------

.. code-block:: bash

    pip install sphinx-needs

.. 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 .
    # or
    poetry 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": "http://github.com/useblocks/sphinx-needs",
    "name": "sphinx-needs",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7.0,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "team useblocks",
    "author_email": "info@useblocks.com",
    "download_url": "https://files.pythonhosted.org/packages/4b/b4/6684cbc8a5cbd379100653c22a5adc0459d1583eff825df17c2c9e27f6eb/sphinx_needs-1.2.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 poetry\n------------\n\n.. code-block:: bash\n\n    poetry add sphinx-needs\n\nUsing pip\n---------\n\n.. code-block:: bash\n\n    pip install sphinx-needs\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    # or\n    poetry 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": "MIT",
    "summary": "Sphinx needs extension for managing needs/requirements and specifications",
    "version": "1.2.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2924286980be10f4029381b0a5ea7f2c99736eadcd705edfb7d0053dbd1cc8f1",
                "md5": "ba01a79b2243f557b772ae7fd1b4cd8d",
                "sha256": "5be7be5760cb55bb48040c6127b369e9829abde168dd48edc960be3bd0d6a43c"
            },
            "downloads": -1,
            "filename": "sphinx_needs-1.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ba01a79b2243f557b772ae7fd1b4cd8d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7.0,<4.0",
            "size": 2608569,
            "upload_time": "2023-01-25T10:40:19",
            "upload_time_iso_8601": "2023-01-25T10:40:19.645099Z",
            "url": "https://files.pythonhosted.org/packages/29/24/286980be10f4029381b0a5ea7f2c99736eadcd705edfb7d0053dbd1cc8f1/sphinx_needs-1.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4bb46684cbc8a5cbd379100653c22a5adc0459d1583eff825df17c2c9e27f6eb",
                "md5": "30cc893b7dc06a879e6e65e6b37e7269",
                "sha256": "5060112dc42ccf67bb1a6f6065ac781505e187c6aa38ed326a7c2db9dcb7a39e"
            },
            "downloads": -1,
            "filename": "sphinx_needs-1.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "30cc893b7dc06a879e6e65e6b37e7269",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7.0,<4.0",
            "size": 2378946,
            "upload_time": "2023-01-25T10:40:21",
            "upload_time_iso_8601": "2023-01-25T10:40:21.536580Z",
            "url": "https://files.pythonhosted.org/packages/4b/b4/6684cbc8a5cbd379100653c22a5adc0459d1583eff825df17c2c9e27f6eb/sphinx_needs-1.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-25 10:40:21",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "useblocks",
    "github_project": "sphinx-needs",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "sphinx-needs"
}
        
Elapsed time: 0.12802s