Add release note and documentation for #312

Author: AWhetter

autoapi/_mapper.py

@@ -230,7 +230,8 @@ def _link_objs(value):
 
     # Strip off the extra "\ "
     return result[:-2]
-    
+
+
 def _path_matches_patterns(path, patterns):
     """Check if a path matches one of multiple patterns
 
@@ -325,13 +326,17 @@ def find_files(patterns, dirs, ignore):
         for _dir in dirs:  # iterate autoapi_dirs
             for root, subdirectories, filenames in os.walk(_dir):
                 # skip directories if needed
-                for sub_dir in subdirectories.copy():  
+                for sub_dir in subdirectories.copy():
                     # iterate copy as we adapt subdirectories during loop
-                    if _path_matches_patterns(os.path.join(root, sub_dir), ignore) == True:
+                    if (
+                        _path_matches_patterns(os.path.join(root, sub_dir), ignore)
+                        == True
+                    ):
                         LOGGER.info(
                             colorize("bold", "[AutoAPI] ")
                             + colorize(
-                                "darkgreen", f"Ignoring directory: {root}/{sub_dir}/")
+                                "darkgreen", f"Ignoring directory: {root}/{sub_dir}/"
+                            )
                         )
                         # adapt original subdirectories inplace
                         subdirectories.remove(sub_dir)
@@ -351,7 +356,8 @@ def find_files(patterns, dirs, ignore):
                             LOGGER.info(
                                 colorize("bold", "[AutoAPI] ")
                                 + colorize(
-                                    "darkgreen", f"Ignoring file: {root}/{filename}")
+                                    "darkgreen", f"Ignoring file: {root}/{filename}"
+                                )
                             )
                             continue
 

docs/changes/312.feature.rst

@@ -0,0 +1 @@
+Can exclude directories from being documented

docs/reference/config.rst

@@ -90,7 +90,7 @@ Customisation Options
 
    Default: ``['*migrations*']``
 
-   A list of patterns to ignore when finding files.
+   A list of patterns to ignore when finding directories and files to document.
 
 .. confval:: autoapi_root