From c64fd69420fd153f9fb16a603ff0a711fbde8335 Mon Sep 17 00:00:00 2001
From: Martin Liska <mliska@suse.cz>
Date: Sun, 13 Nov 2022 15:16:12 +0100
Subject: [PATCH] sphinx: include todolist only if INCLUDE_TODO env. set
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 | 3 +++
doc/indices-and-tables.rst | 2 +-
2 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/doc/baseconf.py b/doc/baseconf.py
index 8021a101e771..c91675d3d049 100644
--- a/doc/baseconf.py
+++ b/doc/baseconf.py
@@ -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'
diff --git a/doc/indices-and-tables.rst b/doc/indices-and-tables.rst
index 56b33139280a..0f4cd2fdc289 100644
--- a/doc/indices-and-tables.rst
+++ b/doc/indices-and-tables.rst
@@ -5,7 +5,7 @@
:ref:`genindex`
- .. only:: development
+ .. only:: include_todo
TODO
----
--
GitLab