Commits

Georg Brandl committed 22893e5

Remove the deprecated ``exclude_dirs`` config value.

  • Participants
  • Parent commits 5ee4e6e

Comments (0)

Files changed (5)

 Release 1.0 (in development)
 ============================
 
+* Remove the deprecated ``exclude_dirs`` config value.
+
 * #129: Wrap toctrees in a div tag with class ``toctree-wrapper``
   in HTML output.
 

File doc/config.rst

 
    .. versionadded:: 0.5
 
-.. confval:: exclude_dirs
-
-   A list of directory names, relative to the source directory, that are to be
-   excluded from the search for source files.
-
-   .. deprecated:: 0.5
-      This does not take subdirs of the excluded directories into account.  Use
-      :confval:`exclude_trees` or :confval:`exclude_dirnames`, which match the
-      expectations.
-
 .. confval:: locale_dirs
 
    .. versionadded:: 0.5

File sphinx/config.py

         source_suffix = ('.rst', 'env'),
         source_encoding = ('utf-8-sig', 'env'),
         unused_docs = ([], 'env'),
-        exclude_dirs = ([], 'env'),
         exclude_trees = ([], 'env'),
         exclude_dirnames = ([], 'env'),
         default_role = (None, 'env'),

File sphinx/environment.py

         """
         Find all source files in the source dir and put them in self.found_docs.
         """
-        exclude_dirs  = [d.replace(SEP, path.sep) for d in config.exclude_dirs]
         exclude_trees = [d.replace(SEP, path.sep) for d in config.exclude_trees]
         self.found_docs = set(get_matching_docs(
             self.srcdir, config.source_suffix,
             exclude_docs=set(config.unused_docs),
-            exclude_dirs=exclude_dirs,
             exclude_trees=exclude_trees,
             exclude_dirnames=['_sources'] + config.exclude_dirnames))
 

File tests/test_config.py

     assert cfg.latex_elements['docclass'] == 'scrartcl'
 
     # simple default values
-    assert 'exclude_dirs' not in cfg.__dict__
-    assert cfg.exclude_dirs == []
+    assert 'locale_dirs' not in cfg.__dict__
+    assert cfg.locale_dirs == []
     assert cfg.show_authors == False
 
     # complex default values