sphinx-directives.py

"""Example reStructuredText from Sphinx-Needs project.

From http://sphinxcontrib-needs.readthedocs.io/en/latest/
but cut down and may not work in isolation. Intended just
to trigger RST303.

**Some data**

.. req:: My first requirement
   :id: req_001
   :tags: example

   This is an awesome requirement and it includes a nice title,
   a given id, a tag and this text as description.

.. spec:: Spec for a requirement
   :links: req_001
   :status: done
   :tags: important; example

   We haven't set an **ID** here, so sphinxcontrib-needs
   will generated one for us.

   But we have **set a link** to our first requirement and
   also a *status* is given.

**Some text**

.. needfilter::
   :tags: example
   :layout: table

This will fail validation unless the directives are ignored:

    $ flake8 RST303/sphinx-directives.py
    RST303/sphinx-directives.py:9:1: RST303 Unknown directive type "req".
    RST303/sphinx-directives.py:16:1: RST303 Unknown directive type "spec".
    RST303/sphinx-directives.py:29:1: RST303 Unknown directive type "needfilter".

The directives can be ignored at the command line or via the
flake8 configuration file.
"""

print("sphinx-needs defines its own reStructuredText directives.")