sphinx: include todolist only if INCLUDE_TODO env. set
authorMartin Liska <mliska@suse.cz>
Sun, 13 Nov 2022 14:16:12 +0000 (15:16 +0100)
committerMartin Liska <mliska@suse.cz>
Sun, 13 Nov 2022 15:41:36 +0000 (16:41 +0100)
It is confusing that 'Indexes and tables' contains TODO. One gets
Index by clicking to the Index link.

PR web/107643

ChangeLog:

* doc/baseconf.py: Set include_todo tag if INCLUDE_TODO env
is set.
* doc/indices-and-tables.rst: Use include_todo tag.

doc/baseconf.py
doc/indices-and-tables.rst

index 8021a10..c91675d 100644 (file)
@@ -51,6 +51,7 @@ gcc_REVISION = read_file('REVISION')
 VERSION_PACKAGE = os.getenv('VERSION_PACKAGE')
 BUGURL = os.getenv('BUGURL')
 MONOCHROMATIC = os.getenv('MONOCHROMATIC')
+INCLUDE_TODO = os.getenv('INCLUDE_TODO')
 
 YEAR = time.strftime('%Y')
 
@@ -215,6 +216,8 @@ def set_common(name, module):
     if gcc_DEVPHASE == 'experimental':
         module['todo_include_todos'] = True
         module['tags'].add('development')
+    if INCLUDE_TODO:
+        module['tags'].add('include_todo')
 
     html_theme_options['source_edit_link'] = f'https://gcc.gnu.org/onlinedocs/{name}' \
                                              '/_sources/{filename}.txt'
index 56b3313..0f4cd2f 100644 (file)
@@ -5,7 +5,7 @@
 
   :ref:`genindex`
 
-  .. only:: development
+  .. only:: include_todo
 
     TODO
     ----