* [PATCH (pushed)] sphinx: include todolist only if INCLUDE_TODO env. set
@ 2022-11-13 15:41 Martin Liška
0 siblings, 0 replies; only message in thread
From: Martin Liška @ 2022-11-13 15:41 UTC (permalink / raw)
To: gcc-patches
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 8021a101e77..c91675d3d04 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 56b33139280..0f4cd2fdc28 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
----
--
2.38.1
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2022-11-13 15:41 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-11-13 15:41 [PATCH (pushed)] sphinx: include todolist only if INCLUDE_TODO env. set Martin Liška
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).