sphinxcontrib-needs


Namesphinxcontrib-needs JSON
Version 0.1.40 PyPI version JSON
download
home_pagehttp://github.com/useblocks/sphinxcontrib-needs
SummarySphinx needs extension for managing needs/requirements and specifications
upload_time2017-10-18 13:49:04
maintainer
docs_urlNone
authorteam useblocks
requires_python
licenseBSD
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            *Complete, rendered documentation*: http://sphinxcontrib-needs.readthedocs.io/en/latest/

This package contains the needs Sphinx extension.

It allows the definition, linking and filtering of 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).

Example
-------

For the rendered output and more documentation, please visit http://sphinxcontrib-needs.readthedocs.io/en/latest/

.. code-block:: rst

    .. req:: My first requirement
       :status: open
       :tags: requirement; test; awesome

       This is my **first** requirement!!
       .. note:: It's awesome :)

    .. spec:: Specification of a requirement
       :id: OWN_ID_123

    .. impl:: Implementation for specification
       :id: impl_01
       :links: OWN_ID_123

    .. test:: Test for XY
       :status: implemented
       :tags: test; user_interface; python27
       :links: OWN_ID_123; impl_01

       This test checks the implementation of :ref:`impl_01` for spec :ref:`OWN_ID_123` inside a
       Python 2.7 environment.

What is a need?
---------------

A need is a generic object, which can become everything you want for your sphinx documentation:
A requirement, a test case, a user story, a bug, an employee, a product or anything else.

But whatever you chose it shall be and how many of them you need, each need is handled the same way.

Each need can contain:

* a **title** (required)
* an **unique id** (optional. Gets calculated based on title if not given)
* a **description**, which supports fully rst and sphinx extensions (optional)
* a **status** (optional)
* several **tags** (optional)
* several **links** to other needs (optional)

You can create filterable overviews of defined needs by using the needfilter directive::

    .. needfiler::
       :status: open;in_progress
       :tags: tests; test; test_case;
       :layout: table

Installation
============

Using pip
---------
::

    pip install sphinxcontrib-needs

Using sources
-------------
::

    git clone https://github.com/useblocks/sphinxcontrib-needs
    python setup.py install

Activation
----------

Add **sphinxcontrib.needs** to your extensions::

    extensions = ["sphinxcontrib.needs",]

            

Raw data

            {
    "maintainer": "", 
    "docs_url": null, 
    "requires_python": "", 
    "maintainer_email": "", 
    "cheesecake_code_kwalitee_id": null, 
    "keywords": "", 
    "upload_time": "2017-10-18 13:49:04", 
    "author": "team useblocks", 
    "home_page": "http://github.com/useblocks/sphinxcontrib-needs", 
    "github_user": "useblocks", 
    "download_url": "https://pypi.python.org/packages/be/4e/b91e99e50733677a71f894233c32a01763a727b5d8ea4d6fba316cf61b4a/sphinxcontrib-needs-0.1.40.tar.gz", 
    "platform": "any", 
    "version": "0.1.40", 
    "cheesecake_documentation_id": null, 
    "description": "*Complete, rendered documentation*: http://sphinxcontrib-needs.readthedocs.io/en/latest/\n\nThis package contains the needs Sphinx extension.\n\nIt allows the definition, linking and filtering of 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\nExample\n-------\n\nFor the rendered output and more documentation, please visit http://sphinxcontrib-needs.readthedocs.io/en/latest/\n\n.. code-block:: rst\n\n    .. req:: My first requirement\n       :status: open\n       :tags: requirement; test; awesome\n\n       This is my **first** requirement!!\n       .. note:: It's awesome :)\n\n    .. spec:: Specification of a requirement\n       :id: OWN_ID_123\n\n    .. impl:: Implementation for specification\n       :id: impl_01\n       :links: OWN_ID_123\n\n    .. test:: Test for XY\n       :status: implemented\n       :tags: test; user_interface; python27\n       :links: OWN_ID_123; impl_01\n\n       This test checks the implementation of :ref:`impl_01` for spec :ref:`OWN_ID_123` inside a\n       Python 2.7 environment.\n\nWhat is a need?\n---------------\n\nA need is a generic object, which can become everything you want for your sphinx documentation:\nA requirement, a test case, a user story, a bug, an employee, a product or anything else.\n\nBut whatever you chose it shall be and how many of them you need, each need is handled the same way.\n\nEach need can contain:\n\n* a **title** (required)\n* an **unique id** (optional. Gets calculated based on title if not given)\n* a **description**, which supports fully rst and sphinx extensions (optional)\n* a **status** (optional)\n* several **tags** (optional)\n* several **links** to other needs (optional)\n\nYou can create filterable overviews of defined needs by using the needfilter directive::\n\n    .. needfiler::\n       :status: open;in_progress\n       :tags: tests; test; test_case;\n       :layout: table\n\nInstallation\n============\n\nUsing pip\n---------\n::\n\n    pip install sphinxcontrib-needs\n\nUsing sources\n-------------\n::\n\n    git clone https://github.com/useblocks/sphinxcontrib-needs\n    python setup.py install\n\nActivation\n----------\n\nAdd **sphinxcontrib.needs** to your extensions::\n\n    extensions = [\"sphinxcontrib.needs\",]\n", 
    "lcname": "sphinxcontrib-needs", 
    "bugtrack_url": null, 
    "github": true, 
    "coveralls": false, 
    "name": "sphinxcontrib-needs", 
    "license": "BSD", 
    "travis_ci": false, 
    "github_project": "sphinxcontrib-needs", 
    "summary": "Sphinx needs extension for managing needs/requirements and specifications", 
    "split_keywords": [], 
    "author_email": "info@useblocks.com", 
    "urls": [
        {
            "has_sig": false, 
            "upload_time": "2017-10-18T13:49:04", 
            "comment_text": "", 
            "python_version": "source", 
            "url": "https://pypi.python.org/packages/be/4e/b91e99e50733677a71f894233c32a01763a727b5d8ea4d6fba316cf61b4a/sphinxcontrib-needs-0.1.40.tar.gz", 
            "md5_digest": "8976810a0c9b049668efd2385084c641", 
            "downloads": 0, 
            "filename": "sphinxcontrib-needs-0.1.40.tar.gz", 
            "packagetype": "sdist", 
            "path": "be/4e/b91e99e50733677a71f894233c32a01763a727b5d8ea4d6fba316cf61b4a/sphinxcontrib-needs-0.1.40.tar.gz", 
            "size": 15036
        }
    ], 
    "_id": null, 
    "cheesecake_installability_id": null
}