summaryrefslogtreecommitdiff
path: root/sphinx
diff options
context:
space:
mode:
authorBenoit Bryon <benoit@marmelune.net>2012-08-30 14:14:44 +0200
committerBenoit Bryon <benoit@marmelune.net>2012-08-30 14:14:44 +0200
commite963eec631c2a1f58da0822a04a0b7219d6a94e9 (patch)
tree66f4246384dc225c7183de1f0421648f49a027f3 /sphinx
parent9ee282995b60455905bf2eefd6fd88f5d1969dab (diff)
downloadsphinx-e963eec631c2a1f58da0822a04a0b7219d6a94e9.tar.gz
Added -l, --followlinks option to sphinx-apidoc.
Diffstat (limited to 'sphinx')
-rw-r--r--sphinx/apidoc.py7
1 files changed, 6 insertions, 1 deletions
diff --git a/sphinx/apidoc.py b/sphinx/apidoc.py
index ec1a8a33..0f937108 100644
--- a/sphinx/apidoc.py
+++ b/sphinx/apidoc.py
@@ -157,7 +157,8 @@ def recurse_tree(rootpath, excludes, opts):
root_package = None
toplevels = []
- for root, subs, files in os.walk(rootpath):
+ followlinks = getattr(opts, 'followlinks', False)
+ for root, subs, files in os.walk(rootpath, followlinks=followlinks):
if is_excluded(root, excludes):
del subs[:]
continue
@@ -246,6 +247,10 @@ Note: By default this script will not overwrite already created files.""")
'(default: 4)', type='int', default=4)
parser.add_option('-f', '--force', action='store_true', dest='force',
help='Overwrite all files')
+ parser.add_option('-l', '--follow-links', action='store_true',
+ dest='followlinks', default=False,
+ help='Follow symbolic links. Powerful when combined ' \
+ 'with collective.recipe.omelette.')
parser.add_option('-n', '--dry-run', action='store_true', dest='dryrun',
help='Run the script without creating files')
parser.add_option('-T', '--no-toc', action='store_true', dest='notoc',