Merge pull request #3668 from adamjstewart/fixes/apidoc-main-argv

Don't ignore first argument passed to sphinx.apidoc.main

sphinx-apidoc.py

@@ -12,4 +12,4 @@ import sys
 
 if __name__ == '__main__':
     from sphinx.apidoc import main
-    sys.exit(main(sys.argv))
+    sys.exit(main(sys.argv[1:]))

sphinx-autogen.py

@@ -12,4 +12,4 @@ import sys
 
 if __name__ == '__main__':
     from sphinx.ext.autosummary.generate import main
-    sys.exit(main(sys.argv))
+    sys.exit(main(sys.argv[1:]))

sphinx-build.py

@@ -12,4 +12,4 @@ import sys
 
 if __name__ == '__main__':
     from sphinx import main
-    sys.exit(main(sys.argv))
+    sys.exit(main(sys.argv[1:]))

sphinx-quickstart.py

@@ -12,4 +12,4 @@ import sys
 
 if __name__ == '__main__':
     from sphinx.quickstart import main
-    sys.exit(main(sys.argv))
+    sys.exit(main(sys.argv[1:]))

sphinx/__init__.py

@@ -63,7 +63,7 @@ if __version__.endswith('+'):
         pass
 
 
-def main(argv=sys.argv):
+def main(argv=sys.argv[1:]):
     # type: (List[str]) -> int
     if sys.argv[1:2] == ['-M']:
         return make_main(argv)
@@ -71,7 +71,7 @@ def main(argv=sys.argv):
         return build_main(argv)
 
 
-def build_main(argv=sys.argv):
+def build_main(argv=sys.argv[1:]):
     # type: (List[str]) -> int
     """Sphinx build "main" command-line entry."""
     if (sys.version_info[:3] < (2, 7, 0) or
@@ -113,12 +113,12 @@ def build_main(argv=sys.argv):
     return cmdline.main(argv)  # type: ignore
 
 
-def make_main(argv=sys.argv):
+def make_main(argv=sys.argv[1:]):
     # type: (List[str]) -> int
     """Sphinx build "make mode" entry."""
     from sphinx import make_mode
-    return make_mode.run_make_mode(argv[2:])  # type: ignore
+    return make_mode.run_make_mode(argv[1:])  # type: ignore
 
 
 if __name__ == '__main__':
-    sys.exit(main(sys.argv))
+    sys.exit(main(sys.argv[1:]))

sphinx/__main__.py

@@ -11,4 +11,4 @@
 import sys
 from sphinx import main
 
-sys.exit(main(sys.argv))
+sys.exit(main(sys.argv[1:]))

sphinx/apidoc.py

@@ -282,7 +282,7 @@ def is_excluded(root, excludes):
     return False
 
 
-def main(argv=sys.argv):
+def main(argv=sys.argv[1:]):
     # type: (List[str]) -> int
     """Parse and check the command line arguments."""
     parser = optparse.OptionParser(
@@ -356,7 +356,7 @@ Note: By default this script will not overwrite already created files.""")
                          dest='ext_' + ext, default=False,
                          help='enable %s extension' % ext)
 
-    (opts, args) = parser.parse_args(argv[1:])
+    (opts, args) = parser.parse_args(argv)
 
     if opts.show_version:
         print('Sphinx (sphinx-apidoc) %s' % __display_version__)

sphinx/cmdline.py

@@ -114,7 +114,7 @@ def handle_exception(app, opts, exception, stderr=sys.stderr):
                   file=stderr)
 
 
-def main(argv):
+def main(argv=sys.argv[1:]):  # type: ignore
     # type: (List[unicode]) -> int
     parser = optparse.OptionParser(USAGE, epilog=EPILOG, formatter=MyFormatter())
     parser.add_option('--version', action='store_true', dest='version',
@@ -181,7 +181,7 @@ def main(argv):
 
     # parse options
     try:
-        opts, args = parser.parse_args(list(argv[1:]))
+        opts, args = parser.parse_args(argv)
     except SystemExit as err:
         return err.code
 

sphinx/ext/autosummary/generate.py

@@ -59,7 +59,7 @@ if False:
     from sphinx.environment import BuildEnvironment  # NOQA
 
 
-def main(argv=sys.argv):
+def main(argv=sys.argv[1:]):
     # type: (List[str]) -> None
     usage = """%prog [OPTIONS] SOURCEFILE ..."""
     p = optparse.OptionParser(usage.strip())
@@ -75,7 +75,7 @@ def main(argv=sys.argv):
     p.add_option("-i", "--imported-members", action="store_true",
                  dest="imported_members", default=False,
                  help="Document imported members (default: %default)")
-    options, args = p.parse_args(argv[1:])
+    options, args = p.parse_args(argv)
 
     if len(args) < 1:
         p.error('no input files given')

sphinx/ext/intersphinx.py

@@ -383,4 +383,4 @@ if __name__ == '__main__':
     import logging  # type: ignore
     logging.basicConfig()
 
-    debug(argv=sys.argv)  # type: ignore
+    debug(argv=sys.argv[1:])  # type: ignore

sphinx/make_mode.py

@@ -302,8 +302,7 @@ class Make(object):
         if doctreedir is None:
             doctreedir = self.builddir_join('doctrees')
 
-        args = [sys.argv[0],
-                '-b', builder,
+        args = ['-b', builder,
                 '-d', doctreedir,
                 self.srcdir,
                 self.builddir_join(builder)]

sphinx/quickstart.py

@@ -570,7 +570,7 @@ class MyFormatter(optparse.IndentedHelpFormatter):
         return "\n".join(result)
 
 
-def main(argv=sys.argv):
+def main(argv=sys.argv[1:]):
     # type: (List[str]) -> int
     if not color_terminal():
         nocolor()
@@ -642,7 +642,7 @@ def main(argv=sys.argv):
 
     # parse options
     try:
-        opts, args = parser.parse_args(argv[1:])
+        opts, args = parser.parse_args(argv)
     except SystemExit as err:
         return err.code
 
@@ -712,4 +712,4 @@ def main(argv=sys.argv):
 
 
 if __name__ == '__main__':
-    sys.exit(main(sys.argv))
+    sys.exit(main(sys.argv[1:]))

tests/test_apidoc.py

@@ -25,7 +25,7 @@ def apidoc(tempdir, apidoc_params):
     _, kwargs = apidoc_params
     coderoot = kwargs.get('coderoot', (rootdir / 'root'))
     outdir = tempdir / 'out'
-    args = ['sphinx-apidoc', '-o', outdir, '-F', coderoot] + kwargs.get('options', [])
+    args = ['-o', outdir, '-F', coderoot] + kwargs.get('options', [])
     apidoc_main(args)
     return namedtuple('apidoc', 'coderoot,outdir')(coderoot, outdir)
 

tests/test_quickstart.py

@@ -296,8 +296,7 @@ def test_default_filename(tempdir):
 
 
 def test_extensions(tempdir):
-    qs.main(['sphinx-quickstart', '-q',
-             '-p', 'project_name', '-a', 'author',
+    qs.main(['-q', '-p', 'project_name', '-a', 'author',
              '--extensions', 'foo,bar,baz', tempdir])
 
     conffile = tempdir / 'conf.py'

utils/check_sources.py

@@ -179,13 +179,13 @@ def check_xhtml(fn, lines):
                 yield lno + 1, "used " + bad_tag
 
 
-def main(argv):
+def main(argv=sys.argv[1:]):
     parser = OptionParser(usage='Usage: %prog [-v] [-i ignorepath]* [path]')
     parser.add_option('-v', '--verbose', dest='verbose', default=False,
                       action='store_true')
     parser.add_option('-i', '--ignore-path', dest='ignored_paths',
                       default=[], action='append')
-    options, args = parser.parse_args(argv[1:])
+    options, args = parser.parse_args(argv)
 
     if len(args) == 0:
         path = '.'
@@ -256,4 +256,4 @@ def main(argv):
 
 
 if __name__ == '__main__':
-    sys.exit(main(sys.argv))
+    sys.exit(main(sys.argv[1:]))