Commit Graph

34 Commits

Author SHA1 Message Date
Marcus Schäfer
07f557ced4 Bump version: 8.12.0 → 8.13.0 2016-04-21 16:27:36 +02:00
Marcus Schäfer
c4f022161c Bump version: 8.11.0 → 8.12.0 2016-04-21 12:16:26 +02:00
Marcus Schäfer
2c31d70ecb
Fixed documentation link references
Use redirected target and fix broken targets according to
link check on make build
2016-04-21 12:07:09 +02:00
Marcus Schäfer
ec60cc58a8
Fixed typo in documentation
Missing question mark at end of sentence
2016-04-21 11:51:36 +02:00
Marcus Schäfer
6368ef0ab8 Bump version: 8.10.1 → 8.11.0 2016-04-21 11:46:53 +02:00
Marcus Schäfer
4b1c59624c
Fixed typo 2016-04-21 11:46:18 +02:00
Marcus Schäfer
785b3a0447
Added Legacy KIWI vs. Next Generation chapter 2016-04-21 11:32:21 +02:00
Thomas Schraitle
0b1460aa49 More substantial changes of the doc
* Overall: try to be more consistent
* index.rst
  * Move "Supported Distributions" and "Dropped Features" sections
* Quick Start:
  * Add abstract
  * Add note about automatic link creation
  * Move "example appliance description" sections and subsections
    further down
  * Streamlined "Contributing" section
  * Corrected titles and distinguish more between descriptive and
    procedural
2016-04-20 17:01:36 +02:00
Thomas Schraitle
bb5ae9f5e6 Remove useless substitutions (placeholders) 2016-04-20 15:22:15 +02:00
Thomas Schraitle
fd849229cb Add KIWI logo 2016-04-20 15:21:16 +02:00
Thomas Schraitle
a15e1cf0e0 Move Motivation section from quickstart to index 2016-04-20 15:20:56 +02:00
Thomas Schraitle
4aad113d98 Correct heading and remove build status 2016-04-20 12:39:55 +02:00
Thomas Schraitle
30ee0d2291 Add QuickStart Guide and improve documentation
* Added Quick Start Guide, taken from README.md
* Improve index/main file:
  * Shortend main entry page
  * Make more headings
  * Add feature highlights to draw attention
  * Add sidebar with important KIWI links
  * Use ordered list of KIWI concept (prep and creation step)
2016-04-20 11:35:32 +02:00
Marcus Schäfer
7de75965ea
Move program name from kiwi-py3 to kiwi-ng 2016-04-19 11:02:43 +02:00
Marcus Schäfer
63253068ca
Fixed documentation linkcheck results 2016-04-18 17:12:39 +02:00
Marcus Schäfer
fb805ee100
Update documentation entry page 2016-04-18 16:57:17 +02:00
Marcus Schäfer
6468b7c8ab Ignore auto generated code for API docs 2016-04-10 22:51:20 +02:00
Marcus Schäfer
9be138acc8 Update api documentation setup 2016-04-08 16:10:15 +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
Marcus Schäfer
467d3ee54c Move manual page documentation in subdirectory
Separate api documentation from manual pages
2016-04-08 16:10:15 +02:00
Marcus Schäfer
5de6fd5781
Spelling fixes 2016-02-24 10:37:00 +01:00
Thomas Schraitle
a3de628ac6 Update word list 2016-02-24 08:24:32 +01:00
Thomas Schraitle
0b751fe513 Remove empty line to avoid error message
Avoid following error message:
   CRITICAL **: enchant_is_title_case: assertion `word && *word' failed
2016-02-23 21:11:33 +01:00
Thomas Schraitle
cb579a822b Activate personal spellchecking dictionary 2016-02-23 20:58:12 +01:00
Thomas Schraitle
a9d0eddd89 Integrated Tox
* First incarnation of tox.ini
* Extend MANIFEST.in
* Add doc/requirements.txt
* Extend conf.py with 'sphinxcontrib.spelling' extension
* Add wordlist to doc/source/spelling_wordlist.txt
* Add flake8 section in setup.cfg
2016-02-23 15:57:56 +01:00
Marcus Schäfer
8d738b31d1
Added man page for result bundle command 2016-02-15 00:14:22 +01:00
Marcus Schäfer
64a7b83958
Added system update manual page 2016-02-11 17:08:30 +01:00
Marcus Schäfer
2ec23f212e
Create manual pages
Create man pages for result list, system build, prepare and create
2016-02-11 16:24:09 +01:00
Marcus Schäfer
54421f1240
Added compatibility information to main man page 2016-02-10 11:19:34 +01:00
Marcus Schäfer
d6e65f5d4a
Added quick start example to main kiwi manual page 2016-02-10 09:07:44 +01:00
Marcus Schäfer
ebc0a4ef43
Fill master manual page with content 2016-02-09 22:37:52 +01:00
Marcus Schäfer
e132246b35
Added man page templates for all commands 2016-02-06 13:55:10 +01:00
Marcus Schäfer
b6945bb7e6
Added man page templates
Added template for master page and result_list
2016-02-05 12:06:40 +01:00
Marcus Schäfer
4c4ae90aff
Added initial sphinx documentation structure
The documentation will cover kiwi manual pages. more detailed
documentation will be written and maintained in colaboration
with the documentation department
2016-02-05 11:08:03 +01:00