eve/docs/mkdocs/prepare_mkdocs.py at 9b2bcdf8473634eeec6336d7e6cc68f2976e11f7 · rene/eve · 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
#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""This script prepares documentation files for mkdocs."""

import os
import sys
import shutil
import re

# Output directory for document sources
if len(sys.argv) <= 2:
    print("Use: python", sys.argv[0], "<output-directory> <repository-url>")
    sys.exit(1)
else:
    outdir  = sys.argv[1]
    repourl = sys.argv[2]

# Regex
reLinks  = re.compile(r'\[([^\]]+)\]\(([^)]+)\)')
# pylint: disable-next=line-too-long
reURL    = re.compile(r'^(https?|ftp):\/\/([A-Za-z0-9-]+\.)+[A-Za-z]{2,6}(:\d+)?(\/[A-Za-z0-9-._~:?#[\]@!$&\'()*+,;=\/]*)?$')
reMAIL   = re.compile(r'mailto:.*')
reANCHOR = re.compile(r'^#.*')

# All extensions for document sources
docsources = [".md", ".markdown", ".txt", ".png", ".svg", ".gif", ".jpg", ".jpeg"]
# Extensions for markdown files
mkdfiles   = [".md", ".markdown"]

# Create output directory
os.makedirs(outdir, exist_ok=True)

# Search for all document sources in repository
pwd = os.getcwd()
for root, sub, files in os.walk(pwd):
    for f in files:
        fstr  = os.path.splitext(f)
        fext  = fstr[len(fstr) - 1]
        try:
            # Only get files with extensions in the list
            ext   = docsources.index(fext)
            fpath = os.path.join(root, f)
            rpath = os.path.relpath(fpath, start=pwd)

            # Get directory path from file
            dpath = os.path.dirname(rpath)

            # Don't look on output directory
            if os.path.commonpath([dpath, outdir]) == outdir:
                break

            # Create corresponding directory
            npath = os.path.join(outdir, dpath)
            if os.path.isdir(npath) is False:
                try:
                    os.makedirs(npath, exist_ok=True)
                except OSError as error:
                    print(error)

            # Destination file
            destfile = os.path.join(npath, f)

            # Process document source file
            try:
                sidx = mkdfiles.index(docsources[ext])
                with open(fpath, encoding=sys.getdefaultencoding()) as fp:
                    with open(destfile, "w", encoding=sys.getdefaultencoding()) as fout:
                        ftxt = fp.read()

                        # Search for all markdown links in the file
                        mdlinks = reLinks.findall(ftxt)

                        for l in mdlinks:
                            # If the link is not an URL, check if it points to a
                            # non-document source file. If so, convert it to
                            # an URL for source code repository
                            link = l[1].strip()
                            if reURL.match(link) or reANCHOR.match(link) or reMAIL.match(link):
                                continue
                            # Not an URL, remove anchor link (if exist)
                            flink = re.sub(r'#.*','',link)

                            try:
                                # Get file extension of the link
                                lstr = os.path.splitext(flink)
                                lext = lstr[len(lstr) - 1]
                                didx = docsources.index(lext)
                                # It's a document source, we don't need to process
                                continue
                            except ValueError:
                                # Build the full URL for the link
                                lrpath = os.path.relpath(fpath, start=pwd)
                                ldpath = os.path.dirname(lrpath)
                                lurl   = repourl + "/" + ldpath + "/" + flink
                                # Substitute link with the full URL in the text
                                ftxt = ftxt.replace("(" + flink, "(" + lurl)

                        fout.write(ftxt)
                        fout.close()
                        fp.close()
            except ValueError:
                # Not a source file, just copy the file
                shutil.copy(fpath, destfile)
        finally:
            continue