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

Added changelog as a translatable document. Copy license appropiately

Browse Source
This commit is contained in:
Manuel Cortez 2018-12-19 04:58:34 -06:00
parent ea917c470e
commit dfa597f2d0
3 changed files with 27 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitlab-ci.yml
View File

@ -10,7 +10,6 @@ production:
- python documentation_importer.py - python documentation_importer.py
- cd ..\src - cd ..\src
- python ..\doc\generator.py - python ..\doc\generator.py
- copy ..\license.txt documentation\license.txt
- python setup.py py2exe - python setup.py py2exe
- cd .. - cd ..
- cd scripts - cd scripts

36
doc/generator.py
View File

@ -1,21 +1,32 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
import markdown import markdown
import os import os
import shutil
from codecs import open as _open from codecs import open as _open
import languageHandler import languageHandler
languageHandler.setLanguage("en") languageHandler.setLanguage("en")
import strings
import changelog
# the list of supported language codes of TW Blue # the list of supported language codes
languages = ["en", "es"] languages = ["en", "es"]
def generate_document(language): def generate_document(language, document_type="documentation"):
if os.path.exists("documentation") == False:
os.mkdir("documentation")
import strings
reload(languageHandler) reload(languageHandler)
languageHandler.setLanguage(language) if document_type == "documentation":
reload(strings) translation_file = "socializer-documentation"
markdown_file = markdown.markdown("\n".join(strings.documentation[1:]), extensions=["markdown.extensions.toc"]) languageHandler.setLanguage(language, translation_file)
reload(strings)
markdown_file = markdown.markdown("\n".join(strings.documentation[1:]), extensions=["markdown.extensions.toc"])
title = strings.documentation[0]
filename = "manual.html"
elif document_type == "changelog":
translation_file = "socializer-changelog"
languageHandler.setLanguage(language, translation_file)
reload(changelog)
markdown_file = markdown.markdown("\n".join(changelog.documentation[1:]), extensions=["markdown.extensions.toc"])
title = changelog.documentation[0]
filename = "changelog.html"
first_html_block = """<!doctype html> first_html_block = """<!doctype html>
<html lang="%s"> <html lang="%s">
<head> <head>
@ -24,20 +35,25 @@ def generate_document(language):
</head> </head>
<body> <body>
<header><h1>%s</h1></header> <header><h1>%s</h1></header>
""" % (language, strings.documentation[0], strings.documentation[0]) """ % (language, 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", language)):
os.mkdir(os.path.join("documentation", language)) os.mkdir(os.path.join("documentation", language))
mdfile = _open("%s/manual.html" % os.path.join("documentation", language), "w", encoding="utf-8") mdfile = _open(os.path.join("documentation", language, 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():
print("Creating documentation in the supported languages...\n") print("Creating documentation in the supported languages...\n")
if not os.path.exists("documentation"):
os.mkdir("documentation")
if os.path.exists(os.path.join("documentation", "license.txt")) == False:
shutil.copy(os.path.join("..", "license.txt"), os.path.join("documentation", "license.txt"))
for i in languages: for i in languages:
print("Creating documentation for: %s" % (i,)) print("Creating documentation for: %s" % (i,))
generate_document(i) generate_document(i)
generate_document(i, "changelog")
print("Done") print("Done")
create_documentation() create_documentation()

2
src/setup.py
View File

@ -47,7 +47,7 @@ def get_data():
]+get_sounds()+get_locales()+get_documentation()+accessible_output2.find_datafiles()+enchant.utils.win32_data_files()+get_architecture_files()+sound_lib.find_datafiles() ]+get_sounds()+get_locales()+get_documentation()+accessible_output2.find_datafiles()+enchant.utils.win32_data_files()+get_architecture_files()+sound_lib.find_datafiles()
def get_documentation (): def get_documentation ():
answer = [] answer = [("documentation", ["documentation/license.txt"])]
depth = 6 depth = 6
for root, dirs, files in os.walk('documentation'): for root, dirs, files in os.walk('documentation'):
if depth == 0: if depth == 0: