Merge pull request #3 from wkentaro/generate-img-table-only-doc-exists

Generate image table for only doc which exists

doc/add_img_tables_to_index.py

@@ -1,9 +1,24 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
+"""Script to add image table with link to document
+to index file of sphinx documentation.
 
+Usage::
+
+    # in conf.py for sphinx doc
+    exclude_patterns = ['_build', 'venv']
+    import add_img_tables_to_index
+    add_img_tables_to_index.main(exclude_patterns)
+"""
+
+import hashlib
 import os
 import sys
-import hashlib
+
+
+__copyright__ = '2015, JSK Lab'
+__author__ = 'Kentaro Wada <www.kentaro.wada@gmail.com>'
+__version__ = '0.1'
 
 
 def rst_image_table_data(url_prefix, img_files):
@@ -13,6 +28,10 @@ def rst_image_table_data(url_prefix, img_files):
     blocks = []
     for i, img_file in enumerate(img_files):
         title, _ = os.path.splitext(img_file)
+        doc_candidates = [os.path.join(url_prefix, title + ext)
+                          for ext in ['.rst', '.md']]
+        if not any(map(os.path.exists, doc_candidates)):
+            continue
         img_file = os.path.join(url_prefix, 'images', img_file)
         label_name = hashlib.sha1(title).hexdigest()[:8]
         labels.append('''\