|
|
@ -19,7 +19,7 @@ The correct out/ dir is already part of git. |
|
|
|
import sys |
|
|
|
sys.path.append("../../engine") |
|
|
|
from config import METADATA |
|
|
|
from subprocess import run |
|
|
|
import subprocess |
|
|
|
from os import getcwd |
|
|
|
import os.path |
|
|
|
assert os.path.exists(os.path.join(getcwd(), __file__)), (getcwd(), __file__) |
|
|
@ -85,5 +85,50 @@ for language in METADATA["supportedLanguages"].keys(): |
|
|
|
with open (f"../../documentation/{language}.adoc", "w") as w: |
|
|
|
w.write(template) |
|
|
|
|
|
|
|
|
|
|
|
#Create manpage |
|
|
|
#Needs help2man |
|
|
|
manpage_template = f""" |
|
|
|
[name] |
|
|
|
{METADATA["name"]} - {METADATA["tagline"]} |
|
|
|
|
|
|
|
[usage] |
|
|
|
{METADATA["description"]} |
|
|
|
|
|
|
|
[Reporting bugs] |
|
|
|
https://www.laborejo.org/bugs |
|
|
|
|
|
|
|
[copyright] |
|
|
|
{METADATA["name"]} {METADATA["version"]} - Copyright {METADATA["year"]} |
|
|
|
{METADATA["author"]} |
|
|
|
https://www.laborejo.org/ |
|
|
|
|
|
|
|
[examples] |
|
|
|
Start {METADATA["shortName"]} through NSM, e.g. through Argodejo. This will take care of all |
|
|
|
settings and save directories. |
|
|
|
|
|
|
|
Other modes of operations, mostly for testing, are: |
|
|
|
|
|
|
|
Run without session management and save in /tmp. |
|
|
|
{METADATA["shortName"]} --save /tmp |
|
|
|
|
|
|
|
Run without audio and midi. Skips all JACK checks. Used to just look at the GUI, e.g. to make screenshots |
|
|
|
{METADATA["shortName"]} --mute |
|
|
|
|
|
|
|
[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 https://www.laborejo.org/documentation/{METADATA["shortName"]} |
|
|
|
""" |
|
|
|
|
|
|
|
with open ("../../documentation/manpageinclude.h2m", "w") as w: |
|
|
|
w.write(manpage_template) |
|
|
|
|
|
|
|
command = f"help2man ../../{METADATA['shortName']} --no-info --include ../../documentation/manpageinclude.h2m > ../../documentation/{METADATA['shortName']}.1" |
|
|
|
subprocess.run(command, capture_output=True, text=True, shell=True) |
|
|
|
|
|
|
|
|
|
|
|
#print ("Built /documentation. You still need to run /documentation/build-documentation.sh manually") |
|
|
|
print ("Built template part of documentation.") |
|
|
|