Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOC-285

Enable sphinxcontrib-needs extension in Documentation Project

XMLWordPrintable

      As part of VNFRQTS-236 the VNFRQTS team would like to move to associating metadata with the requirements.

      To enable these, we'd like to use the [sphinxcontrib-needs extension|hhttp://sphinxcontrib-needs.readthedocs.io/en/latest/].

      Per prior conversations with Rich Bennett, I believe we've aligned on this as a workable solution.

      To enable this the following updates would be needed:

      1. Add it as a dependency in tox or requirements.txt

      sphinxcontrib-needs>0.2.3

      2. Add it to the configured extensions in conf.py

      extensions = [

      1. other extensions
        'sphinxcontrib.needs', # <- Add this
        ]

      3. Set additional settings in conf.py. Please see the attached file for those settings. They can be added anywhere in the conf.py file.

            rb2745 rb2745
            tl2972 tl2972
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: