#! /usr/bin/env python3 # -*- coding: utf-8 -*- """ This documentation is licensed under Creative Commons-BY-SA-4.0. Please read the provided documentation/LICENSE file or visit https://creativecommons.org/licenses/by-sa/4.0/legalcode The documentation is built statically and does not belong to the normal build process with configure and make Its updating is part of the development process, not packaging and running. The correct out/ dir is already part of git. .adoc is asciidoctor, not simple asciidoc. """ #Make the readme import sys sys.path.append("../../engine") from config import METADATA from subprocess import run from os import getcwd import os.path assert os.path.exists(os.path.join(getcwd(), __file__)), (getcwd(), __file__) #Readme with open("readme.template", "r") as r: template_readme = r.read() template_readme = template_readme.replace("", METADATA["name"]) template_readme = template_readme.replace("", METADATA["version"]) template_readme = template_readme.replace("", METADATA["shortName"]) template_readme = template_readme.replace("", METADATA["description"]) template_readme = template_readme.replace("", METADATA["dependencies"]) template_readme = template_readme.replace("", METADATA["author"]) with open ("../../README.md", "w") as w: w.write(template_readme) print ("Built /README.md") #Documentation index with open("index.adoc.template", "r") as r: template_index = r.read() template_index = template_index.replace("", METADATA["name"]) template_index = template_index.replace("", METADATA["shortName"]) template_index = template_index.replace("", METADATA["version"]) template_index = template_index.replace("", METADATA["author"]) with open ("../../documentation/index.adoc", "w") as w: w.write(template_index) #print ("Built /documentation/index.adoc. You still need to run /documentation/build-documentation.sh manually") #print ("Built /documentation/index.adoc") #Documentation METADATA["supportedLanguages"].update({"English":""}) for language in METADATA["supportedLanguages"].keys(): language = language.lower() try: with open(f"{language}.adoc.template", "r") as r: template = r.read() except: continue #language not yet supported as manual for key, value in METADATA.items(): #all strings if type(value) is str: template = template.replace(f"<{key}>", value) if language == "english": template = template.replace("", "== Introduction\n\n" + METADATA["description"]) with open (f"../../documentation/{language}.part.adoc", "r") as clientPart: template = template.replace("", clientPart.read()) with open (f"../../documentation/{language}.adoc", "w") as w: w.write(template) #print ("Built /documentation. You still need to run /documentation/build-documentation.sh manually") print ("Built template part of documentation.")