Tool to go around sphinx limitation during developpement

Carreau · Carreau · commit 85db7036a935 · 2018-09-06T22:20:25.000+02:00
diff --git a/tools/fixup_whats_new_pr.py b/tools/fixup_whats_new_pr.py
@@ -0,0 +1,43 @@
+"""
+This tool is used during CI testing to make sure sphinx raise no error.
+
+During development, we like to have whatsnew/pr/*.rst documents to track
+individual new features. Unfortunately they other either:
+  - have no title (sphinx complains)
+  - are not included in any toctree (sphinx complain)
+
+This fix-them up by "inventing" a title, before building the docs. At release
+time, these title and files will anyway be rewritten into the actual release
+notes.
+"""
+
+import glob
+
+
+def main():
+    folder = 'docs/source/whatsnew/pr/'
+    assert folder.endswith('/')
+    files = glob.glob(folder+'*.rst')
+    print(files)
+
+    for filename in files:
+        print('Adding pseudo-title to:', filename)
+        title = filename[:-4].split('/')[-1].replace('-', ' ').capitalize()
+
+        with open(filename) as f:
+            data = f.read()
+        if data and data.splitlines()[1].startswith('='):
+            continue
+
+        with open(filename, 'w') as f:
+            f.write(title+'\n')
+            f.write('='* len(title)+'\n\n')
+            f.write(data)
+
+if __name__ == '__main__':
+    main()
+
+
+
+
+
