-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
41997e6
commit 76069fb
Showing
730 changed files
with
11 additions
and
7,213 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"python.pythonPath": "/home/dan/Code/python/sphinxcontrib-needs/.venv/bin/python3", | ||
"git.ignoreLimitWarning": true | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,62 +0,0 @@ | ||
**Complete documentation**: http://sphinxcontrib-needs.readthedocs.io/en/latest/ | ||
|
||
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 | ||
--------- | ||
:: | ||
|
||
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",] | ||
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file was deleted.
Oops, something went wrong.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file not shown.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.