Commit Graph

4 Commits

Author SHA1 Message Date
Marcus Schäfer
89226abd46
Addded doc_suse tox target to build docbook target
SUSE documentation is based on docbook or asciidoc. The kiwi
documentation is maintained along with the code and uses the
sphinx system and therefore ReST as markup language. We would
like to keep one source and don't want to move to another markup
language. Thus the sources needs to be structured in a way that
allows translation into sphinx supported targets as well as
into SUSE docbook style. This commit changes the documentation
structure in a way that both is possible. With the use of Sphinx
XML and rstxml2docbook the ReST docs are converted into docbook.
From there the SUSE daps tool can create SUSE documentation
2020-02-14 15:14:30 +01:00
Marcus Schäfer
2046220c07 Refactor documentation layout and structure
The current design of the documentation does not allow for
continous improvement and development. It's missing a basic
structure and concept for documenting step-by-step workflows
and generic explanations.
2017-05-10 16:32:23 +02:00
Thomas Schraitle
c40d397b6e Small spelling corrections
Apply title style:
* package -> Package
* module -> Module
* Use backticks for kiwi.* modules to avoid spelling problems
2016-04-26 09:17:04 +02:00
Marcus Schäfer
b2552121f8 Create Initial autodoc structure
Called 'sphinx-apidoc -o source/api ../kiwi'
2016-04-08 16:10:15 +02:00