Music production session manager
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

128 lines
4.1 KiB

#! /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
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
from config import METADATA
import subprocess
from os import getcwd
import os.path
assert os.path.exists(os.path.join(getcwd(), __file__)), (getcwd(), __file__)
import datetime
with open("readme.template", "r") as r:
template_readme =
template_readme = template_readme.replace("<date>",
template_readme = template_readme.replace("<name>", METADATA["name"])
template_readme = template_readme.replace("<version>", METADATA["version"])
template_readme = template_readme.replace("<shortname>", METADATA["shortName"])
template_readme = template_readme.replace("<description>", METADATA["description"])
template_readme = template_readme.replace("<dependencies>", METADATA["dependencies"])
template_readme = template_readme.replace("<author>", METADATA["author"])
with open ("../", "w") as w:
print ("Built /")
#Documentation index
with open("index.adoc.template", "r") as r:
template_index =
template_index = template_index.replace("<name>", METADATA["name"])
template_index = template_index.replace("<shortname>", METADATA["shortName"])
template_index = template_index.replace("<version>", METADATA["version"])
template_index = template_index.replace("<author>", METADATA["author"])
with open ("index.adoc", "w") as w:
for language in METADATA["supportedLanguages"].keys():
language = language.lower()
with open(f"{language}.adoc.template", "r") as r:
template =
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("<english-only-description>", "== Introduction\n\n" + METADATA["description"])
with open (f"{language}.part.adoc", "r") as clientPart:
template = template.replace("<manual>",
with open (f"{language}.adoc", "w") as w:
#Create manpage
#Needs help2man
manpage_template = f"""
{METADATA["name"]} - {METADATA["tagline"]}
[Reporting bugs]
{METADATA["name"]} {METADATA["version"]} - Copyright {METADATA["year"]}
Run agordejo. You are now in the Quick View mode. Press New Session and add programs through a
single click on available program-icons. You can switch to the Full View mode via the tab to
get more options. Try right-clicking on many things to get context menus.
[see also]
The full documentation for {METADATA["name"]} is maintained as a multi-lingual html site to your systems doc-dir.
For example:
xdg-open file:///usr/share/doc/{METADATA["shortName"]}/index.html
The documentation can also be found online{METADATA["shortName"]}
with open ("manpageinclude.h2m", "w") as w:
command = f"help2man ../{METADATA['shortName']} --no-info --include manpageinclude.h2m > {METADATA['shortName']}.1", capture_output=True, text=True, shell=True)
#help2man for the much simpler nsm-data
commandNsmDataMNan = "help2man ../tools/nsm-data --no-info > nsm-data.1", capture_output=True, text=True, shell=True)
print ("Built. You still need to run")
print ("sh")