Sphinx-Needs¶

template option for needs¶

Use template, pre_template or post_template to define the location of a template-file, which contains extra data/content.

This templates are based on jinja and have access to the current need data (title, id, status, content, …).

Example of a template stored as file extra_title.need in needs_templates/:

**{{title}}** ({{id}})

The above code will add a simple line with title and id of the need.

To set it in front of a need use pre_template:

.. spec:: my need
   :pre_template: extra_title

To set a template automatically, use global_options

needs_global_options = {
   'pre_template': [
         ('extra_title', 'type=="spec"')
   ],

ID: sphinx_needs_templates

Overview

Connected objects

Problems

needs_pre_post_content: Add content before/after need

Tools

sphinx: Sphinx

sphinx_needs: Sphinx-Needs

Flowchart

$@startuml ' Nodes definition node "<size:12>Problem</size>\n**Add content**\n**before/after**\n**need**\n<size:10>needs_pre_post_content</size>" as needs_pre_post_content [[../problems/sphinx_needs.html#needs_pre_post_content]] #cb5d7e node "<size:12>Solution</size>\n**template option**\n**for needs**\n<size:10>sphinx_needs_templates</size>" as sphinx_needs_templates [[../solutions/sphinx_needs.html#sphinx_needs_templates]] #7dca5d node "<size:12>Tool</size>\n**Sphinx**\n<size:10>sphinx</size>" as sphinx [[../tools/sphinx.html#sphinx]] #5d7ecb node "<size:12>Tool</size>\n**Sphinx-Needs**\n<size:10>sphinx_needs</size>" as sphinx_needs [[../tools/sphinx.html#sphinx_needs]] #5d7ecb ' Connection definition sphinx_needs_templates -[bold,#7dca5d]-> needs_pre_post_content: solves sphinx_needs_templates -[bold,#5d7ecb]-> sphinx: uses sphinx_needs_templates -[bold,#5d7ecb]-> sphinx_needs: uses sphinx_needs -[bold,#5d7ecb]-> sphinx: uses @enduml$