##// END OF EJS Templates
run darker
rushabh-v -
Show More
@@ -1,39 +1,39 b''
1 """
1 """
2 This tool is used during CI testing to make sure sphinx raise no error.
2 This tool is used during CI testing to make sure sphinx raise no error.
3
3
4 During development, we like to have whatsnew/pr/*.rst documents to track
4 During development, we like to have whatsnew/pr/*.rst documents to track
5 individual new features. Unfortunately they other either:
5 individual new features. Unfortunately they other either:
6 - have no title (sphinx complains)
6 - have no title (sphinx complains)
7 - are not included in any toctree (sphinx complain)
7 - are not included in any toctree (sphinx complain)
8
8
9 This fix-them up by "inventing" a title, before building the docs. At release
9 This fix-them up by "inventing" a title, before building the docs. At release
10 time, these title and files will anyway be rewritten into the actual release
10 time, these title and files will anyway be rewritten into the actual release
11 notes.
11 notes.
12 """
12 """
13
13
14 from pathlib import Path
14 from pathlib import Path
15
15
16 def main():
16 def main():
17 folder = Path('docs/source/whatsnew/pr/')
17 folder = Path("docs/source/whatsnew/pr/")
18 files = list(folder.glob('*.rst'))
18 files = list(folder.glob("*.rst"))
19 print(files)
19 print(files)
20
20
21 for filepath in files:
21 for filepath in files:
22 print('Adding pseudo-title to:', filepath.name)
22 print("Adding pseudo-title to:", filepath.name)
23 title = filepath.name[:-4].split('/')[-1].replace('-', ' ').capitalize()
23 title = filepath.name[:-4].split("/")[-1].replace("-", " ").capitalize()
24
24
25 data = filepath.read_text()
25 data = filepath.read_text()
26 try:
26 try:
27 if data and data.splitlines()[1].startswith('='):
27 if data and data.splitlines()[1].startswith('='):
28 continue
28 continue
29 except IndexError:
29 except IndexError:
30 pass
30 pass
31
31
32 with filepath.open('w') as f:
32 with filepath.open("w") as f:
33 f.write(title+'\n')
33 f.write(title + "\n")
34 f.write('='* len(title)+'\n\n')
34 f.write("=" * len(title) + "\n\n")
35 f.write(data)
35 f.write(data)
36
36
37 if __name__ == '__main__':
37 if __name__ == '__main__':
38 main()
38 main()
39
39
General Comments 0
You need to be logged in to leave comments. Login now