mcvsoftware/socializer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated documentation generation, now translations should work again

Browse Source
This commit is contained in:
Manuel Cortez 2021-12-31 18:21:44 -06:00
parent 99279a8dab
commit cf68b524a8
No known key found for this signature in database
GPG Key ID: 262CC30FA01B5CBF
3 changed files with 71 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
changelog.md
View File

@ -1,4 +1,4 @@
# Changelog Changelog
## News in this version ## News in this version

69
doc/generator.py
View File

@ -4,28 +4,47 @@ import os
import locale import locale
import markdown import markdown
import shutil import shutil
from codecs import open as _open
from importlib import reload from importlib import reload
def change_language(name, language): # Languages already translated or translating the documentation.
global _ documentation_languages = ["ru", "en", "es"]
os.environ["lang"] = language
_ = gettext.install(name, os.path.join(os.getcwd(), "locales"))
languages = ["en", "ru"] # Changelog translated languages.
changelog_languages = ["ru", "en", "es"]
def generate_document(language, document_type="documentation"): # this function will help us to have both strings.py and changelog.py without issues by installing a global dummy translation function.
translation_file = "socializer-documentation" def install_null_translation(name):
change_language(translation_file, language) _ = gettext.NullTranslations()
_.install()
return
def get_translations(name):
""" Create translation instances for every language of the translated document. """
translations = {}
if "documentation" in name:
langs = documentation_languages
else:
langs = changelog_languages
for l in langs:
if l != "en":
_ = gettext.translation(name, os.path.join(os.getcwd(), "locales"), languages=[l])
translations[l] = _
else:
_ = gettext.NullTranslations()
translations[l] = _
return translations
def generate_document(lang, lang_name, document_type="documentation"):
""" Generates a document by using the provided lang object, which should be a translation, and lang_name, which should be the two letter code representing the language. """
if document_type == "documentation": if document_type == "documentation":
reload(strings) translation_file = "socializer-documentation"
markdown_file = markdown.markdown("\n".join(strings.documentation[1:]), extensions=["markdown.extensions.toc"]) markdown_file = markdown.markdown("\n".join([lang.gettext(s) if s != "" else s for s in strings.documentation[1:]]), extensions=["markdown.extensions.toc"])
title = strings.documentation[0][1:] title = lang.gettext(strings.documentation[0])
filename = "manual.html" filename = "manual.html"
elif document_type == "changelog": elif document_type == "changelog":
reload(changelog) translation_file = "socializer-documentation"
markdown_file = markdown.markdown("\n".join(changelog.documentation[1:]), extensions=["markdown.extensions.toc"]) markdown_file = markdown.markdown("\n".join([lang.gettext(s) if s != "" else s for s in changelog.documentation[1:]]), extensions=["markdown.extensions.toc"])
title = changelog.documentation[0][1:] title = lang.gettext(changelog.documentation[0])
filename = "changelog.html" filename = "changelog.html"
first_html_block = """<!doctype html> first_html_block = """<!doctype html>
<html lang="%s"> <html lang="%s">
@ -35,28 +54,32 @@ def generate_document(language, document_type="documentation"):
</head> </head>
<body> <body>
<header><h1>%s</h1></header> <header><h1>%s</h1></header>
""" % (language, title, title) """ % (lang_name, title, title)
first_html_block = first_html_block+ markdown_file first_html_block = first_html_block+ markdown_file
first_html_block = first_html_block + "\n</body>\n</html>" first_html_block = first_html_block + "\n</body>\n</html>"
if not os.path.exists(os.path.join("documentation", language)): if not os.path.exists(os.path.join("documentation", lang_name)):
os.mkdir(os.path.join("documentation", language)) os.mkdir(os.path.join("documentation", lang_name))
mdfile = _open(os.path.join("documentation", language, filename), "w", encoding="utf-8") mdfile = open(os.path.join("documentation", lang_name, filename), "w", encoding="utf-8")
mdfile.write(first_html_block) mdfile.write(first_html_block)
mdfile.close() mdfile.close()
def create_documentation(): def create_documentation():
changelog_translations = get_translations("socializer-documentation")
documentation_translations = get_translations("socializer-documentation")
print("Creating documentation in the supported languages...\n") print("Creating documentation in the supported languages...\n")
if not os.path.exists("documentation"): if not os.path.exists("documentation"):
os.mkdir("documentation") os.mkdir("documentation")
if os.path.exists(os.path.join("documentation", "license.txt")) == False: if os.path.exists(os.path.join("documentation", "license.txt")) == False:
shutil.copy(os.path.join("..", "license.txt"), os.path.join("documentation", "license.txt")) shutil.copy(os.path.join("..", "license.txt"), os.path.join("documentation", "license.txt"))
for i in languages: for i in documentation_languages:
print("Creating documentation for: %s" % (i,)) print("Creating documentation for: %s" % (i,))
generate_document(i) generate_document(lang_name=i, lang=documentation_translations.get(i))
generate_document(i, "changelog") for i in changelog_languages:
print("Creating changelog for: %s" % (i,))
generate_document(lang_name=i, lang=changelog_translations.get(i), document_type="changelog")
print("Done") print("Done")
change_language("socializer-documentation", "en") install_null_translation("twblue-documentation")
import strings import strings
import changelog import changelog
create_documentation() create_documentation()

2
doc/manual.md
View File

@ -1,4 +1,4 @@
# Socializer's manual Socializer's manual
## Introduction ## Introduction