diskimage-builder/releasenotes/notes/doc-auto-element-dependency-cb7488c5bb7301a4.yaml

---
features:
  - Create sphinx directive 'element_deps' that automatically
    generates dependencies in the element documentation.
Semi-automatic doc generation of element dependency Currently there is no description of dependencies in the generated documentation of the elements: therefore a user of an element does not know which other elements are automatically included and e.g. which configuration options are available. In addition there are some copy&pastes of parts of the README.rst scattered thought different Ubuntu and Debian specific elements. This patch adds a semi-automatic generation of dependency information of all elements. Nevertheless these are not automatically included. The author of the element's README.rst can decide if and where the dependency information should appear and can use the descriptor .. element_deps:: for this. This patch adds the dependency information for some Debian and Ubuntu patches - and creates the base for later removing the duplicated parts. A call is added to element_dependencies._find_all_elements() to populate reverse dependencies for Element objects. (This is a reworking of I31d2b6050b6c46fefe37378698e9a330025db430 for the feature/v2 branch) Change-Id: Iebb83916fed71565071246baa550849eef40560b 2017-01-19 21:00:21 +00:00			`---`
			`features:`
			`- Create sphinx directive 'element_deps' that automatically`
			`generates dependencies in the element documentation.`