Currently Online

Latest Posts

Changes in Documentation Rules

Old Title


Editor Comment

Initial


Revision Differences of Revision 1

[TOC] ¶

## Introduction ¶

Our [lua documentation](https://www.widelands.org/documentation/index.html) is build with the [Sphinx-doc Documentation creator](https://www.sphinx-doc.org/en/master/index.html). You might have noticed that the documentation has some chapters contains the word "python", this due Sphinx-doc is mainly used to document python projects, but there is no Lua documentation creator we use Sphinx-dco with some difficulties. This article covers the workflow to add Lua documentation, some styling rules and some examples for easy copy and paste. ¶

## Build the documentation locally ¶

The prerequisites for building the documentation locally are: ¶
* python, at least version 3.6 ¶
* [sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html) ¶
* the source code of widelands ¶

To build the documentation see the file README in the subfolder _"doc/sphinx"_ of the widelands source code. ¶

## extract_rst.py ¶

This script gathers [[ #rst-comments | RST-Comments ]] from different locations and stores them as files in _"doc/sphinx/source"_. It creates/adds also some entries to the tocs. ¶

## RST Comments