ENH: Added api_rst_coverage.py (pandas-dev#8166)

Author: seth-p

doc/source/contributing.rst

@@ -316,6 +316,13 @@ Some other important things to know about the docs:
   output saved) during the doc build. This way, they will always be up to date,
   but it makes the doc building a bit more complex.
 
+The utility script ``scripts/api_rst_coverage.py`` can be used to compare
+the list of methods documented in ``doc/source/api.rst`` (which is used to generate
+the `API Reference <http://pandas.pydata.org/pandas-docs/stable/api.html>`_ page)
+and the actual public methods.
+It will identify methods documented in in ``doc/source/api.rst`` that are not actually
+class methods, and existing methods that are not documented in ``doc/source/api.rst``.
+
 
 How to build the pandas documentation
 -------------------------------------

scripts/api_rst_coverage.py

@@ -0,0 +1,43 @@
+import pandas as pd
+import inspect
+import re
+
+def main():
+    # classes whose members to check
+    classes = [pd.Series, pd.DataFrame, pd.Panel, pd.Panel4D]
+
+    def class_name_sort_key(x):
+        if x.startswith('Series'):
+            # make sure Series precedes DataFrame, Panel, and Panel4D
+            return ' ' + x
+        else:
+            return x
+
+    # class members
+    class_members = set()
+    for cls in classes:
+        class_members.update([cls.__name__ + '.' + x[0] for x in inspect.getmembers(cls)])
+
+    # class members referenced in api.rst
+    api_rst_members = set()
+    file_name = '../doc/source/api.rst'
+    with open(file_name, 'r') as f:
+        pattern = re.compile('({})\.(\w+)'.format('|'.join([cls.__name__ for cls in classes])))
+        for line in f:
+            match = pattern.search(line)
+            if match:
+                api_rst_members.add(match.group(0))
+
+    print()
+    print("Documented members in api.rst that aren't actual class members:")
+    for x in sorted(api_rst_members.difference(class_members), key=class_name_sort_key):
+        print(x)
+
+    print()
+    print("Class members (other than those beginning with '_') missing from api.rst:")
+    for x in sorted(class_members.difference(api_rst_members), key=class_name_sort_key):
+        if '._' not in x:
+            print(x)
+
+if __name__ == "__main__":
+    main()