📝 Use sphinx.ext.todo

Freed-Wu · Sep 2, 2023 · d8e6aae · d8e6aae
1 parent 126469f
commit d8e6aae
Show file tree

Hide file tree

Showing 9 changed files with 14 additions and 37 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,6 +1,7 @@
 """Configure the Sphinx documentation builder.
 
 https://www.sphinx-doc.org/en/master/usage/configuration.html
+
 """
 from translate_shell import __version__ as version  # type: ignore
 from translate_shell._metainfo import author, copyright, project
@@ -26,9 +27,10 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinx.ext.githubpages",
     "sphinx.ext.napoleon",
+    "sphinx.ext.todo",
     "sphinx.ext.viewcode",
-    "sphinx.ext.githubpages",
     "myst_parser",
     "sphinxcontrib.autofile",
     "sphinxcontrib.requirements_txt",
@@ -37,6 +39,7 @@
 
 myst_heading_anchors = 3
 myst_title_to_header = True
+todo_include_todos = True
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

diff --git a/docs/misc/acknowledgements.md b/docs/misc/acknowledgements.md
diff --git a/docs/misc/todo.md b/docs/misc/todo.md
@@ -1,7 +1,4 @@
 # TODO
 
-```{eval-bash}
-cd ..
-shopt -s globstar
-scripts/generate-todo.md.pl src/**/*.py
+```{todolist}
 ```
diff --git a/scripts/generate-acknowledgements.md.pl b/scripts/generate-acknowledgements.md.pl
diff --git a/scripts/generate-todo.md.pl b/scripts/generate-todo.md.pl
diff --git a/src/translate_shell/translators/online/yandex.py b/src/translate_shell/translators/online/yandex.py
@@ -1,5 +1,6 @@
 """Yandex Translator
 ====================
 
-TODO: Refer https://github.com/soimort/translate-shell
+.. todo::
+    Refer `<https://github.com/soimort/translate-shell>`_
 """
diff --git a/src/translate_shell/translators/online/youdao.py b/src/translate_shell/translators/online/youdao.py
@@ -1,5 +1,6 @@
 """Youdao Translator
 ====================
 
-TODO: Refer https://github.com/ChestnutHeng/Wudao-dict
+.. todo::
+    Refer `<https://github.com/ChestnutHeng/Wudao-dict>`_.
 """
diff --git a/src/translate_shell/translators/stardict/__init__.py b/src/translate_shell/translators/stardict/__init__.py
@@ -1,9 +1,8 @@
 """Stardict Translator
 ======================
 
-TODO: more stardicts.
-TODO: Create different subclasses for different dict to get phonetic, explains
-better
+.. todo::
+    More stardicts.
 """
 import logging
 import os

diff --git a/src/translate_shell/ui/repl.py b/src/translate_shell/ui/repl.py
@@ -10,6 +10,9 @@
 def run(args: Namespace) -> None:
     """Run.
 
+    .. todo::
+        make the last line gray like ``ptpython``.
+
     :param args:
     :type args: Namespace
     :rtype: None
@@ -29,8 +32,6 @@ def run(args: Namespace) -> None:
             )
             process(args, True)
         except KeyboardInterrupt:
-            # skipcq: PYL-W0511
-            # TODO: make the last line gray like ptpython
             print("")
             continue
         except EOFError: