LycheeOrg.github.io/gen.py at master · BMerz/LycheeOrg.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
#!/usr/bin/env python3

# this script will directly use the version.md from Lychee to determine the current version
import pytest
import shutil
import urllib.request
import markdown
from git import Repo
from utils.tools import read, save, bcolors
from markdown.extensions.toc import TocExtension


def numberify_version(v):
    v = v.split('.')
    if len(v[1]) < 2:
        v[1] = '0'+v[1]
    if len(v[2]) < 2:
        v[2] = '0'+v[2]
    return "".join(v)


def generate_base():
    version = urllib.request.urlopen(
        "https://raw.githubusercontent.com/LycheeOrg/Lychee/master/version.md").read().decode("utf-8")
    version = version.strip()

    print(bcolors.YELLOW + 'version number: '  + bcolors.NORMAL + version+'\n')

    head = read('template/head.tpl')
    index = read('template/index.tpl')
    support = read('template/support.tpl')
    footer = read('template/footer.tpl')
    update = read('template/update.tpl')

    index_full = head % version
    index_full += index % version
    index_full += footer

    support_full = head % version
    support_full += support % version
    support_full += footer

    update_full = update % numberify_version(version)

    save("build/index.html", index_full)
    print(bcolors.GREEN + 'index' + bcolors.NORMAL + " generated.")
    save("build/support.html", support_full)
    print(bcolors.GREEN + 'support' + bcolors.NORMAL + " generated.")
    save("build/update.json", update_full)
    print(bcolors.GREEN + 'update' + bcolors.NORMAL + " generated.")
    print("")


md = markdown.Markdown(extensions=['extra', TocExtension(
    baselevel=1, toc_depth=3, anchorlink=True), 'md_in_html'])
md2 = markdown.Markdown(extensions=['extra', TocExtension(
    baselevel=1, toc_depth=4, anchorlink=True), 'md_in_html'])

frame = read('template/doc-frame.html')

pages_title = {}
pages_title['installation'] = 'Installation'
pages_title['configuration'] = 'Configuration'
pages_title['structure'] = 'Directory Structure'
pages_title['contributions'] = 'Contribution Guide'
pages_title['releases'] = 'Release Notes'
pages_title['api'] = 'API Documentation'
pages_title['faq'] = 'Frequently Asked Question'
pages_title['settings'] = 'Settings'
pages_title['keyboard'] = 'Keyboard Shortcuts'
pages_title['upgrade'] = 'Upgrade from v3'
pages_title['docker'] = 'Docker'
pages_title['read-more'] = 'Lychee logic overview'
pages_title['update'] = 'Update'
pages_title['node'] = 'Front-end'
pages_title['org'] = 'Lychee & LycheeOrg'
pages_title['distributions'] = 'Distributions Examples'

structure = [['Prologue',
              ['org', 'releases', 'upgrade', 'contributions', 'api', 'faq']]]
structure += [['Getting Started',
               ['installation', 'configuration', 'docker', 'update']]]
structure += [['Digging Deeper',
               ['settings', 'keyboard', 'read-more', 'structure', 'node', 'distributions']]]

def gen_github_link(page):
    html = '<blockquote><p>{tip} Caught a mistake or want to contribute to the documentation?&nbsp;'
    html += '<a href="https://github.com/LycheeOrg/LycheeOrg.github.io/tree/master/docs/' + page + '.md">Edit this page on Github!</a></p></blockquote>'
    return html

def gen_sidebar(page):

    html = ''
    for section in structure:
        html += "<li class='sub--on'>\n"
        html += "<h2>{}</h2>\n".format(section[0])
        html += "<ul>\n"
        for pages_name in section[1]:
            active = ''
            if pages_name == page:
                active = " class='active'"
            html += "<li{active}><a href='{page}.html'>{title}</a></li>\n".format(
                active=active, page=pages_name, title=pages_title[pages_name])
        html += "</ul>\n"

    return html

def generate_doc():
    for page_name in pages_title:
        page_title = pages_title[page_name]
        text = read('docs/' + page_name + '.md')
        if page_name == 'settings':
            html = md2.convert(text)
            toc = md2.toc[17:-7]
        else:
            html = md.convert(text)
            toc = md.toc[17:-7]
        aside = gen_sidebar(page_name)
        # print(aside)
        html += gen_github_link(page_name)

        html = frame.format(content=html, title=page_title, toc=toc, aside=aside)
        save('build/docs/' +  page_name + '.html', html)
        print(bcolors.GREEN + page_name + bcolors.NORMAL + " generated.")

    shutil.copy('build/docs/installation.html', 'build/docs/index.html')


def check():
    repo = Repo.init('.')
    if repo.is_dirty():  # check the dirty state
        for item in repo.index.diff(None):
            print(bcolors.RED + item.a_path + " changed." + bcolors.NORMAL)
        print("")
        print(bcolors.RED + "Please commit them." + bcolors.NORMAL)
        return True
    else:
        print(bcolors.GREEN + "No changes detected." + bcolors.NORMAL)
        return False


def test_main():
    generate_base()
    generate_doc()
    assert(not check())


def main():
    generate_base()
    generate_doc()
    check()

if __name__ == '__main__':
    main()