Commit Graph

4 Commits

Author SHA1 Message Date
Dan Čermák
560cb3d149
Turn sphinx warnings into errors
Modify the sphinx Makefile to treat warnings
like undefined references as errors
2019-05-20 11:20:18 +02:00
Marcus Schäfer
1d9ac070e8 Build schema documentation with Oxygen
Given there is a valid Oxygen license owned by the company
as described in https://www.oxygenxml.com/oxygen_scripting.html
the schema documentation can be created using Oxygen. This
commit allows building the schema docs with alternative
doc builders and in case of Oxygen would change the way the
schema docs are generated in the following way:

1. Install Oxygen and setup the license to activate the tool

2. Setup the KIWI development shell environment to export
   the schema_tool variable to point to the schemaDocumentation.sh
   script provided by the Oxygen installation

   export oxygen_tool=/path/to/Oxygen/schemaDocumentation.sh

3. In any case of a schema change manually call:

   tox -e schema

   This step was done before as part of the tox doc target
   but can't be done automatically because it would require
   a correctly licensed Oxygen installation in the travis
   environment. Thus the result data has to be part of the
   pull request

4. Build the documentation and review the result

   tox -e doc

5. Create the pull request
2017-06-29 10:38:45 +02:00
Thomas Schraitle
12856d4c8c Add "spell" rule in Makefile
Also included in the help target
2016-04-26 08:47:07 +02: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