From dde6f9fb61a1de64551a942ce5839fa9f3aae1d9 Mon Sep 17 00:00:00 2001 From: Patrick Watrin <pat@lucy.local> Date: Mon, 29 Feb 2016 11:58:37 +0100 Subject: [PATCH] documentation building howto --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 521ab6a..bbfbed3 100644 --- a/README.md +++ b/README.md @@ -91,11 +91,13 @@ Help on built-in function unitex_tool in module _unitex: unitex_tool(...) This function launches an Unitex command. - Positional arguments (length: 1): - 0 [str] -- the Unitex command. + *Positional arguments (length: 1):* - Return [bool]: - True if the command succeeds, False otherwise. + - **0 [str]** -- the Unitex command. + + *Return [bool]:* + + **True** if the command succeeds, **False** otherwise. ``` If you want to generate HTML documentation from the source files, you can also use the [Sphinx Documentation Generator](http://www.sphinx-doc.org/). -- GitLab