Changeset 924

Timestamp:

Jun 13, 2012 12:42:55 PM (11 years ago)

Author:

jemian

Message:

add docstring

Location:

specdomain/src/specdomain

Files:

• doc/starter.py (modified) (1 diff)
• test/starter.py (modified) (1 diff)

specdomain/src/specdomain/doc/starter.py

@@ -8 +8 @@
 '''
 
-import sphinx, sys
+import os
+import sphinx
+import sys
+
+
+def force_rebuild_all():
+    '''
+    Delete the *doctrees* subdirectory.
+    '''
+    if os.path.exists('_build/doctrees'):
+        garbage_list = [
+            '_build/doctrees/environment.pickle',
+            '_build/doctrees/index.doctree',
+            '_build/doctrees/test_doc.doctree',
+        ]
+        for item in garbage_list:
+            if os.path.exists(item):
+                os.remove(item)
+        os.rmdir('_build/doctrees')
+
 
 if __name__ == '__main__':
-    args = []
-    args.append(sys.argv[0])
-    args = args + "-b html".split()
-    args = args + "-d _build/doctrees .".split()
-    args = args + "_build/html".split()
+    force_rebuild_all()
+    args = [sys.argv[0]] + "-b html -d _build/doctrees . _build/html".split()
     sphinx.main(args)

specdomain/src/specdomain/test/starter.py

@@ -14 +14 @@
 
 def force_rebuild_all():
+    '''
+    Delete the *doctrees* subdirectory.
+    '''
     if os.path.exists('_build/doctrees'):
         garbage_list = [