PTU5KAS/docs/index.rst

Welcome to the kas documentation, a setup tool for bitbake based projects
=========================================================================

Contents:

.. toctree::
   :maxdepth: 2

   intro
   userguide
   command-line
   devguide
   format-changelog

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Added initial sphinx documentation This commit adds initial files for the Sphinx documentation system and expanded checkcode.sh to include `doc8` as documentation checker. Also added this checker to the dependencies for travis CI. Signed-off-by: Claudius Heine <ch@denx.de> 2017-06-28 14:48:46 +02:00			`Welcome to the kas documentation, a setup tool for bitbake based projects`
			`=========================================================================`

			`Contents:`

			`.. toctree::`
			`:maxdepth: 2`

Moved documentation from README.md to sphinx documentation system Signed-off-by: Claudius Heine <ch@denx.de> 2017-06-28 14:48:48 +02:00			`intro`
			`userguide`
docs: Move command line details to a separate page This change makes the user guide page more readable and results in a command line usage page which is easy to navigate as all sub-commands can be found in the left-hand outline panel. Also fix the layout of the environment variables table by using a replacement. Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com> 2020-11-06 12:50:16 +01:00			`command-line`
Moved documentation from README.md to sphinx documentation system Signed-off-by: Claudius Heine <ch@denx.de> 2017-06-28 14:48:48 +02:00			`devguide`
Switch to separate config file version Use a separately incremented integer to track the configuration file format version. We start with 2 due to the change that 23c3a951f6e4 introduced. 1 is declared to be equivalent to the original '0.10'. The separate versioning has the advantage of being able to increment it already during the development cycle, and using it with config files that test/exploit the new format. Using an integer has the advantages of a) differentiating it clearly from the now independent kas version and b) simplifying the version parsing. We can now also remove the string type restriction. Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com> 2017-07-17 22:38:05 +02:00			`format-changelog`
Moved documentation from README.md to sphinx documentation system Signed-off-by: Claudius Heine <ch@denx.de> 2017-06-28 14:48:48 +02:00
Added initial sphinx documentation This commit adds initial files for the Sphinx documentation system and expanded checkcode.sh to include `doc8` as documentation checker. Also added this checker to the dependencies for travis CI. Signed-off-by: Claudius Heine <ch@denx.de> 2017-06-28 14:48:46 +02:00			`Indices and tables`
			`==================`

			* :ref:`genindex`
			* :ref:`modindex`
			* :ref:`search`