diskimage-builder/doc/source/elements.rst

Elements
========

Elements are found in the subdirectory elements. Each element is in a directory
named after the element itself. Elements *should* have a README.rst in the root
of the element directory describing what it is for.

.. toctree::
   :glob:

   elements/*/*
Split out README into separate files This makes the docs site a lot more manageable and begins moving us in the direction of separate user and developer docs. Change-Id: I1650ef9d5be1733b8bc118d99090143cb5b06102 2015-02-12 07:07:47 +00:00			`Elements`
			`========`

			`Elements are found in the subdirectory elements. Each element is in a directory`
			`named after the element itself. Elements should have a README.rst in the root`
			`of the element directory describing what it is for.`

			`.. toctree::`
			`:glob:`

Fix up element doc generation Turns out that you really have to have the elements dir symlinked under the source directory for the globbing to match anything. AFAICT there's no way to add external directories to the sphinx build. Change-Id: Iaa3576ef250822b0d57bebce1ebbe03e5bafa042 2017-02-08 03:17:05 +00:00			`elements//`