Merge pull request #78 from docascode/yitian/suppress-todo

Add a new directive to suppress useless TODO information

docfx_yaml/directives.py

@@ -30,3 +30,17 @@ def run(self):
         return_nodes.append(node)
 
         return return_nodes
+
+class TodoDirective(Directive):
+    """
+    Class to ignore todo directive.
+    """
+
+    # Enable content in the directive
+    has_content = True
+
+    # Directive class must override run function.
+    def run(self):
+        return_nodes = []
+
+        return return_nodes

docfx_yaml/extension.py

@@ -25,7 +25,7 @@
 from .utils import transform_node, transform_string
 from .settings import API_ROOT
 from .monkeypatch import patch_docfields
-from .directives import RemarksDirective
+from .directives import RemarksDirective, TodoDirective
 from .nodes import remarks
 
 
@@ -706,6 +706,7 @@ def setup(app):
 
     app.add_node(remarks, html = (remarks.visit_remarks, remarks.depart_remarks))
     app.add_directive('remarks', RemarksDirective)
+    app.add_directive('todo', TodoDirective)
 
     app.connect('builder-inited', build_init)
     app.connect('autodoc-process-docstring', process_docstring)

setup.py

@@ -13,7 +13,7 @@
 
 setup(
     name='sphinx-docfx-yaml',
-    version='1.2.41',
+    version='1.2.42',
     author='Eric Holscher',
     author_email='eric@ericholscher.com',
     url='https://github.com/ericholscher/sphinx-docfx-yaml',