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
|
#!/usr/bin/python
# /*##########################################################################
#
# Copyright (c) 2016 European Synchrotron Radiation Facility
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# ###########################################################################*/
"""Script to update icons.rst file according to icons available in resources.
"""
__authors__ = ["Thomas Vincent"]
__license__ = "MIT"
__date__ = "27/07/2018"
import os
import glob
PROJECT_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
ICONS_RST_DIR = os.path.join(PROJECT_ROOT, "doc", "source", "modules", "gui")
ICONS_RST_FILENAME = os.path.join(ICONS_RST_DIR, "icons.rst")
ICONS_DIR = os.path.join(
PROJECT_ROOT, "src", "silx", "resources", "gui", "icons", "*.png"
)
ICONS_RST_HEADER = """
.. AUTOMATICALLY GENERATED FILE DO NOT EDIT
Use %s script instead
.. currentmodule:: silx.gui
:mod:`icons`: Set of icons
--------------------------
.. automodule:: silx.gui.icons
:members:
Available icons
+++++++++++++++
.. list-table::
:widths: 1 4
:header-rows: 1
* - Icon
- Name
""" % os.path.basename(
__file__
)
def main():
"""Write icons.rst file"""
icons = glob.glob(ICONS_DIR)
icons = [os.path.relpath(f, ICONS_RST_DIR) for f in icons]
icons = sorted(icons)
icons_table = "\n".join(
" * - |%s|\n - %s" % (os.path.basename(f)[:-4], os.path.basename(f)[:-4])
for f in icons
)
icon_definitions = "\n".join(
".. |%s| image:: %s" % (os.path.basename(f)[:-4], f) for f in icons
)
content = ICONS_RST_HEADER + icons_table + "\n\n" + icon_definitions + "\n"
# Write to file
with open(ICONS_RST_FILENAME, "w") as f:
f.write(content)
if __name__ == "__main__":
main()
|
