mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-08-07 03:35:16 -05:00
The deprecated config values `exclude_trees, exclude_dirnames and unused_docs` have been removed.
This commit is contained in:
@@ -8,6 +8,9 @@ Incompatible changes
|
|||||||
|
|
||||||
* Removed the ``sphinx.ext.oldcmarkup`` extension.
|
* Removed the ``sphinx.ext.oldcmarkup`` extension.
|
||||||
|
|
||||||
|
* The deprecated config values ``exclude_trees``, ``exclude_dirnames`` and
|
||||||
|
``unused_docs`` have been removed.
|
||||||
|
|
||||||
* A new node, ``sphinx.addnodes.literal_strong``, has been added, for text that
|
* A new node, ``sphinx.addnodes.literal_strong``, has been added, for text that
|
||||||
should appear literally (i.e. no smart quotes) in strong font. Custom writers
|
should appear literally (i.e. no smart quotes) in strong font. Custom writers
|
||||||
will have to be adapted to handle this node.
|
will have to be adapted to handle this node.
|
||||||
|
|||||||
@@ -114,38 +114,6 @@ General configuration
|
|||||||
|
|
||||||
.. versionadded:: 1.0
|
.. versionadded:: 1.0
|
||||||
|
|
||||||
.. confval:: unused_docs
|
|
||||||
|
|
||||||
A list of document names that are present, but not currently included in the
|
|
||||||
toctree. Use this setting to suppress the warning that is normally emitted
|
|
||||||
in that case.
|
|
||||||
|
|
||||||
.. deprecated:: 1.0
|
|
||||||
Use :confval:`exclude_patterns` or :ref:`metadata` instead.
|
|
||||||
|
|
||||||
.. 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
|
|
||||||
|
|
||||||
.. deprecated:: 1.0
|
|
||||||
Use :confval:`exclude_patterns` instead.
|
|
||||||
|
|
||||||
.. 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
|
|
||||||
|
|
||||||
.. deprecated:: 1.0
|
|
||||||
Use :confval:`exclude_patterns` instead.
|
|
||||||
|
|
||||||
.. confval:: templates_path
|
.. confval:: templates_path
|
||||||
|
|
||||||
A list of paths that contain extra templates (or templates that overwrite
|
A list of paths that contain extra templates (or templates that overwrite
|
||||||
|
|||||||
@@ -579,10 +579,7 @@ class StandaloneHTMLBuilder(Builder):
|
|||||||
# then, copy over all user-supplied static files
|
# then, copy over all user-supplied static files
|
||||||
staticentries = [path.join(self.confdir, spath)
|
staticentries = [path.join(self.confdir, spath)
|
||||||
for spath in self.config.html_static_path]
|
for spath in self.config.html_static_path]
|
||||||
matchers = compile_matchers(
|
matchers = compile_matchers(self.config.exclude_patterns)
|
||||||
self.config.exclude_patterns +
|
|
||||||
['**/' + d for d in self.config.exclude_dirnames]
|
|
||||||
)
|
|
||||||
for entry in staticentries:
|
for entry in staticentries:
|
||||||
if not path.exists(entry):
|
if not path.exists(entry):
|
||||||
self.warn('html_static_path entry %r does not exist' % entry)
|
self.warn('html_static_path entry %r does not exist' % entry)
|
||||||
|
|||||||
@@ -51,10 +51,6 @@ class Config(object):
|
|||||||
source_suffix = ('.rst', 'env'),
|
source_suffix = ('.rst', 'env'),
|
||||||
source_encoding = ('utf-8-sig', 'env'),
|
source_encoding = ('utf-8-sig', 'env'),
|
||||||
exclude_patterns = ([], 'env'),
|
exclude_patterns = ([], 'env'),
|
||||||
# the next three are all deprecated now
|
|
||||||
unused_docs = ([], 'env'),
|
|
||||||
exclude_trees = ([], 'env'),
|
|
||||||
exclude_dirnames = ([], 'env'),
|
|
||||||
default_role = (None, 'env'),
|
default_role = (None, 'env'),
|
||||||
add_function_parentheses = (True, 'env'),
|
add_function_parentheses = (True, 'env'),
|
||||||
add_module_names = (True, 'env'),
|
add_module_names = (True, 'env'),
|
||||||
|
|||||||
@@ -333,9 +333,6 @@ class BuildEnvironment:
|
|||||||
matchers = compile_matchers(
|
matchers = compile_matchers(
|
||||||
config.exclude_patterns[:] +
|
config.exclude_patterns[:] +
|
||||||
config.html_extra_path +
|
config.html_extra_path +
|
||||||
config.exclude_trees +
|
|
||||||
[d + config.source_suffix for d in config.unused_docs] +
|
|
||||||
['**/' + d for d in config.exclude_dirnames] +
|
|
||||||
['**/_sources', '.#*']
|
['**/_sources', '.#*']
|
||||||
)
|
)
|
||||||
self.found_docs = set(get_matching_docs(
|
self.found_docs = set(get_matching_docs(
|
||||||
|
|||||||
@@ -23,7 +23,6 @@ copyright = '2010, Georg Brandl & Team'
|
|||||||
version = '0.6'
|
version = '0.6'
|
||||||
release = '0.6alpha1'
|
release = '0.6alpha1'
|
||||||
today_fmt = '%B %d, %Y'
|
today_fmt = '%B %d, %Y'
|
||||||
# unused_docs = []
|
|
||||||
exclude_patterns = ['_build', '**/excluded.*']
|
exclude_patterns = ['_build', '**/excluded.*']
|
||||||
keep_warnings = True
|
keep_warnings = True
|
||||||
pygments_style = 'sphinx'
|
pygments_style = 'sphinx'
|
||||||
|
|||||||
Reference in New Issue
Block a user