Skip to content

Commit

Permalink
restructure for poetry
Browse files Browse the repository at this point in the history
  • Loading branch information
danieleades committed Sep 14, 2020
1 parent 41997e6 commit 76069fb
Show file tree
Hide file tree
Showing 730 changed files with 11 additions and 7,213 deletions.
4 changes: 4 additions & 0 deletions .vscode/settings.json
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
}
62 changes: 0 additions & 62 deletions README.rst
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",]
4 changes: 0 additions & 4 deletions doc-requirements.txt

This file was deleted.

20 changes: 0 additions & 20 deletions docs/Makefile

This file was deleted.

Binary file removed docs/_images/daniel.png
Binary file not shown.
Binary file removed docs/_images/need_1.png
Binary file not shown.
Binary file removed docs/_images/need_2.png
Binary file not shown.
Binary file removed docs/_images/need_pie_10fbc.png
Binary file not shown.
Binary file removed docs/_images/need_pie_132a2.png
Binary file not shown.
Binary file removed docs/_images/need_pie_1bc0e.png
Binary file not shown.
Binary file removed docs/_images/need_pie_2c3ed.png
Binary file not shown.
Binary file removed docs/_images/need_pie_3d372.png
Binary file not shown.
Binary file removed docs/_images/need_pie_47238.png
Binary file not shown.
Binary file removed docs/_images/need_pie_64ad3.png
Binary file not shown.
Binary file removed docs/_images/need_pie_76ebe.png
Binary file not shown.
Binary file removed docs/_images/need_pie_873ef.png
Binary file not shown.
Binary file removed docs/_images/need_pie_88777.png
Binary file not shown.
Binary file removed docs/_images/need_pie_ca835.png
Binary file not shown.
Binary file removed docs/_images/need_pie_d0d45.png
Binary file not shown.
Binary file removed docs/_images/need_pie_d192f.png
Binary file not shown.
Binary file removed docs/_images/need_pie_dbfaf.png
Binary file not shown.
Binary file removed docs/_images/need_pie_df318.png
Binary file not shown.
Binary file removed docs/_images/need_pie_df9e6.png
Binary file not shown.
Binary file removed docs/_images/need_pie_e2e07.png
Binary file not shown.
Binary file removed docs/_images/need_pie_fd3f3.png
Binary file not shown.
Binary file removed docs/_images/needflow_1.png
Binary file not shown.
Binary file removed docs/_images/needpie_1.png
Binary file not shown.
Binary file removed docs/_images/needs_logo.png
Binary file not shown.
Binary file removed docs/_images/needtable_1.png
Binary file not shown.
7 changes: 0 additions & 7 deletions docs/_static/custom.css

This file was deleted.

Binary file removed docs/_static/diagram.png
Diff not rendered.
Binary file removed docs/_static/need_blank.png
Diff not rendered.
Binary file removed docs/_static/need_dark.png
Diff not rendered.
Binary file removed docs/_static/need_modern.png
Diff not rendered.
Binary file removed docs/_static/need_part_as_flow.png
Diff not rendered.
Binary file removed docs/_static/needflow_flow.png
Diff not rendered.
Binary file removed docs/_static/needflow_flow_legend.png
Diff not rendered.
Binary file removed docs/_static/needflow_link_names.png
Diff not rendered.
Binary file removed docs/_static/needs_logo.png
Diff not rendered.
Binary file removed docs/_static/needs_logo_big.png
Diff not rendered.
Binary file removed docs/_static/sphinx_needs_paper.odt
Binary file not shown.
Binary file removed docs/_static/sphinx_needs_paper.pdf
Binary file not shown.
1 change: 0 additions & 1 deletion docs/_static/status_closed.svg
Diff not rendered.
1 change: 0 additions & 1 deletion docs/_static/status_in_progress.svg
Diff not rendered.
1 change: 0 additions & 1 deletion docs/_static/status_open.svg
Diff not rendered.
Binary file removed docs/_static/useblocks_logo.png
Diff not rendered.
31 changes: 0 additions & 31 deletions docs/api.rst

This file was deleted.

131 changes: 0 additions & 131 deletions docs/builders.rst

This file was deleted.

0 comments on commit 76069fb

Please sign in to comment.