mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Closes #930: sphinx-apidoc allow wildcards for excluding paths.
This commit is contained in:
parent
2de1cd7fde
commit
86c54575be
1
CHANGES
1
CHANGES
@ -20,6 +20,7 @@ Features added
|
||||
:confval:`linkcheck_anchors_ignore`
|
||||
* #3083: let Unicode no-break space act like LaTeX ``~`` (fixed #3019)
|
||||
* #3116: allow word wrap in PDF output for inline literals (ref #3110)
|
||||
* #930: sphinx-apidoc allow wildcards for excluding paths. Thanks to Nick Coghlan.
|
||||
|
||||
Bugs fixed
|
||||
----------
|
||||
|
@ -21,6 +21,7 @@ import sys
|
||||
import optparse
|
||||
from os import path
|
||||
from six import binary_type
|
||||
from fnmatch import fnmatch
|
||||
|
||||
from sphinx.util.osutil import FileAvoidWrite, walk
|
||||
from sphinx import __display_version__
|
||||
@ -257,7 +258,7 @@ def is_excluded(root, excludes):
|
||||
e.g. an exlude "foo" also accidentally excluding "foobar".
|
||||
"""
|
||||
for exclude in excludes:
|
||||
if root == exclude:
|
||||
if fnmatch(root, exclude):
|
||||
return True
|
||||
return False
|
||||
|
||||
@ -266,13 +267,13 @@ def main(argv=sys.argv):
|
||||
"""Parse and check the command line arguments."""
|
||||
parser = optparse.OptionParser(
|
||||
usage="""\
|
||||
usage: %prog [options] -o <output_path> <module_path> [exclude_path, ...]
|
||||
usage: %prog [options] -o <output_path> <module_path> [exclude_pattern, ...]
|
||||
|
||||
Look recursively in <module_path> for Python modules and packages and create
|
||||
one reST file with automodule directives per package in the <output_path>.
|
||||
|
||||
The <exclude_path>s can be files and/or directories that will be excluded
|
||||
from generation.
|
||||
The <exclude_pattern>s can be file and/or directory patterns that will be
|
||||
excluded from generation.
|
||||
|
||||
Note: By default this script will not overwrite already created files.""")
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user