danbooru-client/doc
2015-02-22 17:02:36 +01:00
..
CMakeLists.txt Use the proper macro for docs 2015-02-22 16:37:29 +01:00
index.docbook Add a stub handbook 2015-02-22 17:02:36 +01:00
README.DOC initial project import from KDevelop 2013-02-17 10:19:02 +01:00

How to add a documentation to your project:

* copy a template from kdelibs/kdoctools/ to this directory
  - article-template.docbook -> article for a short documentation e.g. for a plugin
  - template.docbook -> book template for an application
  rename the template to index.docbook
  edit the content of index.docbook, never use an unmodified template
  if you need help with the docbook format mail to the documentation team (kde-doc-english@kde.org)

* if your documentation is finished, add the doc directory to the CMakeLists.txt in the parent dir
  (uncomment the line "#add_subdirectory( doc )"
 
* to get your documentation into the translation process, mail to the translation team (kde-i18n-doc@kde.org)