Allow "none" in autodoc (#455)

* Allow "none" in autodoc

* Add tests ensuring that "none" doesn't add anchors

Author: tomaarsen

src/doc_builder/autodoc.py

@@ -492,6 +492,8 @@ def autodoc(object_name, package, methods=None, return_anchors=False, page_info=
             methods.remove("all")
             methods_to_add = find_documented_methods(obj)
             methods.extend([m for m in methods_to_add if m not in methods])
+        elif "none" in methods:
+            methods = []
         for method in methods:
             anchor_name = f"{anchors[0]}.{method}"
             method_doc, check = document_object(

tests/test_autodoc.py

@@ -324,6 +324,12 @@ def test_autodoc_return_anchors(self):
             ],
         )
 
+        _, anchors, _ = autodoc("BertTokenizer", transformers, methods=["none"], return_anchors=True)
+        self.assertListEqual(anchors, ["transformers.BertTokenizer"])
+
+        _, anchors, _ = autodoc("BertTokenizer", transformers, methods=["none", "__call__"], return_anchors=True)
+        self.assertListEqual(anchors, ["transformers.BertTokenizer"])
+
         _, anchors, _ = autodoc("BertTokenizer", transformers, methods=["__call__"], return_anchors=True)
         self.assertListEqual(
             anchors,