Doc: remove the todo plugin
Remove the sphinx todo plugin as managing a task list in the
documentation is confusing and inefficient.
Change-Id: I08912ac636c098865f187cef232cfb5f314a6d4d
Signed-off-by: Gyorgy Szing <Gyorgy.Szing@arm.com>
diff --git a/docs/conf.py b/docs/conf.py
index e35a28e..feeca38 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
# -- Metadata about this file ------------------------------------------------
-__copyright__ = "Copyright (c) 2020-2021 Arm Limited and Contributors."
+__copyright__ = "Copyright (c) 2020-2022 Arm Limited and Contributors."
__license__ = "SPDX-License-Identifier: BSD-3-Clause"
# Configuration file for the Sphinx documentation builder.
@@ -31,7 +31,7 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.autosectionlabel', 'sphinxcontrib.plantuml',
- 'sphinxcontrib.moderncmakedomain', 'sphinx.ext.todo']
+ 'sphinxcontrib.moderncmakedomain' ]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -102,7 +102,3 @@
# -- Options for plantuml ----------------------------------------------------
plantuml_output_format = 'svg_img'
-# -- Options for todo extension ----------------------------------------------
-
-# Display todos
-todo_include_todos = False
diff --git a/docs/developer/software-requirements.rst b/docs/developer/software-requirements.rst
index f664553..1449724 100644
--- a/docs/developer/software-requirements.rst
+++ b/docs/developer/software-requirements.rst
@@ -27,8 +27,6 @@
To build the documentation, please refer to :ref:`Documentation Build Instructions`.
-.. todo:: Add info on commit validation dependencies (checkpatch, uncrustify, etc...)
-
--------------
.. _OP-TEE documentation: https://optee.readthedocs.io/en/latest/building/gits/build.html#step-4-get-the-toolchains
diff --git a/docs/developer/writing-documentation.rst b/docs/developer/writing-documentation.rst
index eb10449..243dcec 100644
--- a/docs/developer/writing-documentation.rst
+++ b/docs/developer/writing-documentation.rst
@@ -40,14 +40,15 @@
CMake
'''''
-.. todo:: Add content about how to document cmake scripts.
-
+The project uses the ""`moderncmakedomain`_" Sphinx extension. This allows adding inline documentation to cmake files.
+For details please refer to the documentation of the plugin.
--------------
.. _`Restructured Text`: https://docutils.sourceforge.io/rst.html
.. _`Sphinx`: https://www.sphinx-doc.org
+.. _`moderncmakedomain`: https://github.com/scikit-build/moderncmakedomain
-*Copyright (c) 2020-2021, Arm Limited and Contributors. All rights reserved.*
+*Copyright (c) 2020-2022, Arm Limited and Contributors. All rights reserved.*
SPDX-License-Identifier: BSD-3-Clause
diff --git a/docs/project/coding-guidelines.rst b/docs/project/coding-guidelines.rst
index ca80f1b..5b5607a 100644
--- a/docs/project/coding-guidelines.rst
+++ b/docs/project/coding-guidelines.rst
@@ -69,8 +69,6 @@
#
#-------------------------------------------------------------------------------
-.. todo:: Explain CMake return values and parent scope concept in more detail.
-
Restructured Text Rules
-----------------------
diff --git a/docs/project/index.rst b/docs/project/index.rst
index d9bb409..91ad6bc 100644
--- a/docs/project/index.rst
+++ b/docs/project/index.rst
@@ -12,7 +12,7 @@
license
maintainers
versioning_policy
- todo
+
--------------
diff --git a/docs/project/todo.rst b/docs/project/todo.rst
deleted file mode 100644
index 1739eab..0000000
--- a/docs/project/todo.rst
+++ /dev/null
@@ -1,22 +0,0 @@
-TODO list
-=========
-
-This file collects information on planned future changes and issues to be
-addressed. For managing the TODO list below, the `Sphinx TODO extension`_ is
-used.
-
-.. todo:: Find a solution to make the rendering of TODO entries less intrusive
- at their original location.
-
-List of TODO entries in the project
------------------------------------
-
-.. todolist::
-
---------------
-
-.. _`Sphinx TODO extension`: https://www.sphinx-doc.org/en/master/usage/extensions/todo.html
-
-*Copyright (c) 2020-2021, Arm Limited and Contributors. All rights reserved.*
-
-SPDX-License-Identifier: BSD-3-Clause
\ No newline at end of file