IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add exclude_dirnames value.

Browse Source
This commit is contained in:
Georg Brandl
2008-08-10 17:21:08 +00:00
parent b3f1de1bf7
commit 74d52b40bc
6 changed files with 38 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
doc/config.rst
View File

@@ -80,20 +80,32 @@ General configuration
toctree. Use this setting to suppress the warning that is normally emitted
in that case.
.. confval:: exclude_trees
A list of directory paths, relative to the source directory, that are to be
recursively excluded from the search for source files, that is, their
subdirectories won't be searched too. The default is ``[]``.
.. versionadded:: 0.4
.. confval:: exclude_dirnames
A list of directory names that are to be excluded from any recursive
operation Sphinx performs (e.g. searching for source files or copying static
files). This is useful, for example, to exclude version-control-specific
directories like ``'CVS'``. The default is ``[]``.
.. 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.
.. versionadded:: 0.3
.. confval:: exclude_trees
A list of directory names, relative to the source directory, that are to be
recursively exlucded from the search for source files, that is, their
subdirectories won't be searched too.
.. versionadded:: 0.4
.. deprecated:: 0.5
This does not take subdirs of the excluded directories into account. Use
:confval:`exclude_trees` or :confval:`exclude_dirs`, which match the
expectations.
.. confval:: locale_dirs