Commits

Jon Waltman committed 8f28af8

sphinx-build: Support the standard ``--help`` and ``--version`` options.

  • Participants
  • Parent commits 3c49758

Comments (0)

Files changed (2)

 Release 1.2 (in development)
 ============================
 
+* sphinx-build now supports the standard :option:`--help` and
+  :option:`--version` options.
+
 * #869: sphinx-build now has the option :option:`-T` for printing the full
   traceback after an unhandled exception.
 

sphinx/cmdline.py

          -W        -- turn warnings into errors
          -P        -- run Pdb on exception
          -T        -- show full traceback on exception
+        --help     -- show this help and exit
+        --version  -- show version information and exit
 Modi:
 * without -a and without filenames, write new and changed files.
 * with -a, write all files.
         nocolor()
 
     try:
-        opts, args = getopt.getopt(argv[1:], 'ab:t:d:c:CD:A:ng:NEqQWw:PT')
+        opts, args = getopt.getopt(argv[1:], 'ab:t:d:c:CD:A:ng:NEqQWw:PTh',
+                                   ['help', 'version'])
         allopts = set(opt[0] for opt in opts)
+        if '-h' in allopts or '--help' in allopts:
+            usage(argv)
+            return 0
+        if '--version' in allopts:
+            print 'Sphinx (sphinx-build) %s' %  __version__
+            return 0
         srcdir = confdir = abspath(args[0])
         if not path.isdir(srcdir):
             print >>sys.stderr, 'Error: Cannot find source directory `%s\'.' % (