diff --git a/doc/sphinxext/gen_rst.py b/doc/sphinxext/gen_rst.py index c7e01585f83e..42598d2149f7 100644 --- a/doc/sphinxext/gen_rst.py +++ b/doc/sphinxext/gen_rst.py @@ -121,7 +121,9 @@ def generate_example_rst(app): rstfile = '%s.rst'%basename outrstfile = os.path.join(rstdir, rstfile) - # XXX make into title + # XXX: We might consider putting extra metadata in the example + # files to include a title. If so, this line is where we would add + # this information. fhsubdirIndex.write(' %s <%s>\n'%(os.path.basename(basename),rstfile)) do_plot = (subdir in example_subdirs