The new documentation system has been finished. Doc needs to be updated

2025-07-18 06:06:06 -04:00 · 2014-11-07 16:28:27 -06:00
parent 76a2b0b1ac
commit 9e79bdfbcb
39 changed files with 20386 additions and 3 deletions
--- a/doc/generator.py
+++ b/doc/generator.py
@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+import markdown
+import os
+from codecs import open as _open
+import languageHandler
+languageHandler.setLanguage("en")
+import strings
+
+# the list of supported language codes of TW Blue
+languages = ["en", "es", "fr", "gl"]
+#"eu", "ar", "ca", "es", "fi", "fr", "gl", "hu", "it", "pl", "pt", "ru", "tr"]
+
+def generate_document(language):
+ reload(languageHandler)
+ languageHandler.setLanguage(language)
+ reload(strings)
+ markdown_file = markdown.markdown("\n".join(strings.documentation[1:]), extensions=["markdown.extensions.toc"])
+ first_html_block = """<!doctype html>
+ <html lang="%s">
+ <head>
+  <title>%s</title>
+  <meta charset="utf-8">
+  </head>
+  <body>
+  <header><h1>%s</h1></header>
+  """ %  (language, strings.documentation[0], strings.documentation[0])
+ first_html_block = first_html_block+ markdown_file
+ first_html_block = first_html_block + "\n</body>\n</html>"
+ if not os.path.exists(language):
+  os.mkdir(language)
+ mdfile = _open("%s/manual.html" % language, "w", encoding="utf-8")
+ mdfile.write(first_html_block)
+ mdfile.close()
+
+def create_documentation():
+ print("Creating documentation in the supported languages...\n")
+ for i in languages:
+  print("Creating documentation for: %s" % (i,))
+  generate_document(i)
+ print("Done")
+
+create_documentation()