]> Shamusworld >> Repos - ardour-manual/blobdiff - build.py
Edit pages to reflect jackd not being essential
[ardour-manual] / build.py
index e656fd198efaa0980bb7601c9b001862c780dffa..e9f4f279fee121e237aa9058a148b083179540e6 100755 (executable)
--- a/build.py
+++ b/build.py
@@ -15,7 +15,7 @@ import os
 import re
 import shutil
 import argparse
-
+import datetime
 
 # Global vars
 global_bootstrap_path = '/bootstrap-3.3.7'
@@ -26,6 +26,9 @@ global_screen_template = 'page-template.html'
 global_onepage_template = 'onepage-template.html'
 global_pdf_template = 'pdf-template.html'
 global_master_doc = 'master-doc.txt'
+from datetime import datetime
+global_today_iso = datetime.today().strftime('%Y-%m-%dT%H%M%S')
+global_today = datetime.today().strftime('%Y-%m-%d')
 
 # This matches all *non* letter/number, ' ', '.', '-', and '_' chars
 cleanString = re.compile(r'[^a-zA-Z0-9 \._-]+')
@@ -319,7 +322,7 @@ def FixInternalLinks(links, content, title):
 # looking at currently
 #
 def BuildList(lst, fs, pagePos, cList):
-       content = '\n\n<ul>\n'
+       content = '<ul>\n'
 
        for i in range(len(lst)):
                curPos = lst[i]
@@ -327,7 +330,7 @@ def BuildList(lst, fs, pagePos, cList):
 
                active = ' class=active' if curPos == pagePos else ''
                menuTitle = fs[curPos]['menu_title'] if 'menu_title' in fs[curPos] else fs[curPos]['title']
-               content = content + '<li' + active + '><a href="/' + fs[curPos]['filename'] + '/">' + menuTitle + '</a></li>'
+               content = content + '\t<li' + active + '><a href="/' + fs[curPos]['filename'] + '/">' + menuTitle + '</a></li>\n'
 
                # If the current page is our page, and it has children, enumerate them
                if curPos == pagePos:
@@ -339,7 +342,7 @@ def BuildList(lst, fs, pagePos, cList):
                elif (pagePos > curPos) and (pagePos < nextPos):
                        content = content + BuildList(cList[curPos], fs, pagePos, cList)
 
-       content = content + '\n</ul>\n'
+       content = content + '</ul>\n'
 
        return content
 
@@ -354,7 +357,7 @@ def BuildOnePageSidebar(fs):
        levelNums = [0]*3
 
        for i in range(len(fs)):
-               # Handle Part/Chapter/subchapter/section/subsection numbering
+               # Handle Part/Chapter/subchapter numbering
                level = fs[i]['level']
                if level < 2:
                        levelNums[2] = 0
@@ -395,7 +398,7 @@ def CreateLinkSidebar(fs, pos, childList):
        content = BuildList(FindTopLevelNodes(fs), fs, pos, childList)
        # Shove the TOC link and one file link at the top...
        active = ' class=active' if pos<0 else ''
-       content = content.replace('<ul>','<ul><li' + active + '><a href="/toc/">Table of Contents</a></li>\n',1)
+       content = content.replace('<ul>','<ul><li' + active + '><a href="/toc/">Table of Contents</a></li>',1)
 
        return content
 
@@ -454,11 +457,12 @@ temp.close()
 onepage = onepage.replace('{{page.bootstrap_path}}', global_bootstrap_path)
 onepage = onepage.replace('{{page.page_title}}', global_page_title)
 
-# Same as above, but for the PDF version
-temp = open(global_pdf_template)
-pdfpage = temp.read()
-temp.close()
-pdfpage = pdfpage.replace('{{page.page_title}}', global_page_title)
+if not nopdf:
+       # Same as above, but for the PDF version
+       temp = open(global_pdf_template)
+       pdfpage = temp.read()
+       temp.close()
+       pdfpage = pdfpage.replace('{{page.page_title}}', global_page_title)
 
 # Parse out the master document's structure into a dictionary list
 fileStruct = GetFileStructure()
@@ -514,22 +518,22 @@ for header in fileStruct:
 
                print(header['title'])
 
-       # Handle TOC scriblings and one-page titles...
-       opl = ''
-       if 'link' in header:
-               opl = ' id="' + header['link'] + '"'
-       else:
-               opl = ' id="' + header['filename'] + '"'
-
+       # Handle TOC scriblings...
        if level == 0:
                toc = toc + '<h2>Part ' + num2roman(levelNums[level]) + ': ' + header['title'] + '</h2>\n';
-               oph = '<h1 class="clear"' + opl +'>Part ' + num2roman(levelNums[level]) + ' - ' + header['title'] + '</h1>\n';
        elif level == 1:
                toc = toc + '\t<p class="chapter">Ch. ' + str(levelNums[level]) + ':&nbsp;&nbsp;<a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
-               oph = '<h2 class="clear"' + opl +'>' + str(levelNums[level]) + ' - ' + header['title'] + '</h3>\n';
        elif level == 2:
                toc = toc + '\t\t<p class="subchapter"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
-               oph = '<h3 class="clear"' + opl +'>' + str(levelNums[level-1]) + '.' + str(levelNums[level]) + ' - ' + header['title'] + '</h3>\n';
+
+       # Handle one-page and PDF titles...
+       opl = ''
+       if 'link' in header:
+               opl = ' id="' + header['link'] + '"'
+       else:
+               opl = ' id="' + header['filename'] + '"'
+       oph = '<h' + str(level+1) + ' class="clear"' + opl +'>' + header['title'] + '</h' + str(level+1) + '>\n';
+
 
        # Make the 'this thing contains...' stuff
        if HaveChildren(fileStruct, pageNumber):
@@ -614,7 +618,8 @@ for header in fileStruct:
 
        # Set up the actual page from the template
        onepage = onepage.replace('{{ content }}', oph + '\n' + opcontent + '\n{{ content }}')
-       pdfpage = pdfpage.replace('{{ content }}', oph + '\n' + opcontent + '\n{{ content }}')
+       if not nopdf:
+               pdfpage = pdfpage.replace('{{ content }}', oph + '\n' + opcontent + '\n{{ content }}')
 
        # ----- Normal version -----
 
@@ -678,15 +683,23 @@ if not nopdf:
                print('Generating the PDF...')
 
        # Create the PDF version of the documentation
-       pdfpageFile = open(global_site_dir + 'pdf.html', 'w')
        pdfpage = pdfpage.replace('{% tree %}', opsidebar) # create the TOC
        pdfpage = pdfpage.replace('{{ content }}', '') # cleans up the last spaceholder
+       pdfpage = pdfpage.replace('{{ today }}', global_today)
+       pdfpage = pdfpage.replace('{{ today_iso }}', global_today_iso)
+       pdfpage = pdfpage.replace('src="/images/', 'src="images/') # makes images links relative
+       pdfpage = pdfpage.replace('url(\'/images/', 'url(\'images/') # CSS images links relative
+       # Write it to disk (optional, can be removed)
+       pdfpageFile = open(global_site_dir + 'pdf.html', 'w')
        pdfpageFile.write(pdfpage)
        pdfpageFile.close()
 
+       # Generating the actual PDF with weasyprint (https://weasyprint.org/)
        from weasyprint import HTML
-       doc = HTML(filename = global_site_dir + 'pdf.html')
-       doc.write_pdf(global_site_dir + 'manual.pdf')
+       from weasyprint.fonts import FontConfiguration
+       html_font_config = FontConfiguration()
+       doc = HTML(string = pdfpage, base_url = global_site_dir)
+       doc.write_pdf(global_site_dir + 'manual.pdf', font_config = html_font_config)
 
 if not quiet:
        print('Processed ' + str(fileCount) + ' files.')