summaryrefslogtreecommitdiff
path: root/doc/tools
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2015-12-13 00:01:04 +0100
committerRémi Verschelde <rverschelde@gmail.com>2015-12-13 00:01:04 +0100
commit410e418aea16cc1c07249a9a64d3defcb8990866 (patch)
treeadec28ca65ff39bdc59ed26b427896d3a240b54e /doc/tools
parentaeb5ea59340f91ae445330c95429f903a8f20e8a (diff)
Add a Makefile to generate classes doc in various formats
All the generated documentation is put in doc/_build.
Diffstat (limited to 'doc/tools')
-rw-r--r--doc/tools/doc_merge.py3
-rw-r--r--doc/tools/makedocs.py2
-rw-r--r--doc/tools/makedoku.py5
-rw-r--r--doc/tools/makehtml.py5
-rw-r--r--doc/tools/makemd.py3
5 files changed, 14 insertions, 4 deletions
diff --git a/doc/tools/doc_merge.py b/doc/tools/doc_merge.py
index 872f38ed87..6cc7019324 100644
--- a/doc/tools/doc_merge.py
+++ b/doc/tools/doc_merge.py
@@ -1,3 +1,6 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
import sys
import xml.etree.ElementTree as ET
diff --git a/doc/tools/makedocs.py b/doc/tools/makedocs.py
index be57891abc..db9f04b091 100644
--- a/doc/tools/makedocs.py
+++ b/doc/tools/makedocs.py
@@ -24,7 +24,7 @@
# TODO:
# * Refactor code.
# * Adapt this script for generating content in other markup formats like
-# DokuWiki, Markdown, etc.
+# reStructuredText, Markdown, DokuWiki, etc.
#
# Also check other TODO entries in this script for more information on what is
# left to do.
diff --git a/doc/tools/makedoku.py b/doc/tools/makedoku.py
index e8207715fe..1ab16841b1 100644
--- a/doc/tools/makedoku.py
+++ b/doc/tools/makedoku.py
@@ -1,3 +1,6 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
import sys
import xml.etree.ElementTree as ET
@@ -8,7 +11,7 @@ for arg in sys.argv[1:]:
input_list.append(arg)
if len(input_list) < 1:
- print("usage: makedoku.py <class_list.xml>")
+ print("usage: makedoku.py <classes.xml>")
sys.exit(0)
diff --git a/doc/tools/makehtml.py b/doc/tools/makehtml.py
index 9b9c62f33b..34db47e424 100644
--- a/doc/tools/makehtml.py
+++ b/doc/tools/makehtml.py
@@ -1,3 +1,6 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
import sys
import xml.etree.ElementTree as ET
from xml.sax.saxutils import escape, unescape
@@ -29,7 +32,7 @@ for arg in sys.argv[1:]:
input_list.append(arg)
if len(input_list) < 1:
- print("usage: makehtml.py <class_list.xml>")
+ print("usage: makehtml.py <classes.xml>")
sys.exit(0)
diff --git a/doc/tools/makemd.py b/doc/tools/makemd.py
index f85d145d5e..e012287b0e 100644
--- a/doc/tools/makemd.py
+++ b/doc/tools/makemd.py
@@ -1,5 +1,6 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
+
import sys
import xml.etree.ElementTree as ET
@@ -9,7 +10,7 @@ for arg in sys.argv[1:]:
input_list.append(arg)
if len(input_list) < 1:
- print 'usage: makedoku.py <class_list.xml>'
+ print 'usage: makemd.py <classes.xml>'
sys.exit(0)