Merge branch '1.7' into compat_autosummary

CHANGES

@@ -10,6 +10,8 @@ Incompatible changes
 Deprecated
 ----------
 
+* #4623: ``sphinx.build_main()`` is deprecated. Use
+  ``sphinx.cmd.build.build_main()`` instead.
 * autosummary: The interface of ``sphinx.ext.autosummary.get_documenter()`` has
   been changed (Since 1.7.0)
 
@@ -25,6 +27,8 @@ Bugs fixed
 * #4622: epub: :confval:`epub_scheme` does not effect to content.opf
 * #4627: graphviz: Fit graphviz images to page
 * #4617: quickstart: PROJECT_DIR argument is required
+* #4623: sphinx.build_main no longer exists in 1.7.0
+* #4615: The argument of ``sphinx.build`` has been changed in 1.7.0
 * autosummary: The interface of ``sphinx.ext.autosummary.get_documenter()`` has
   been changed
 

sphinx/__init__.py

@@ -15,6 +15,7 @@
 from __future__ import absolute_import
 
 import os
+import sys
 import warnings
 from os import path
 
@@ -66,9 +67,30 @@ def main(*args, **kwargs):
         RemovedInSphinx20Warning,
         stacklevel=2,
     )
+    args = args[1:]  # skip first argument to adjust arguments (refs: #4615)
     return build.main(*args, **kwargs)
 
 
+def build_main(argv=sys.argv):
+    """Sphinx build "main" command-line entry."""
+    warnings.warn(
+        '`sphinx.build_main()` has moved to `sphinx.cmd.build.build_main()`.',
+        RemovedInSphinx20Warning,
+        stacklevel=2,
+    )
+    return build.build_main(argv[1:])  # skip first argument to adjust arguments (refs: #4615)
+
+
+def make_main(argv=sys.argv):
+    """Sphinx build "make mode" entry."""
+    warnings.warn(
+        '`sphinx.build_main()` has moved to `sphinx.cmd.build.make_main()`.',
+        RemovedInSphinx20Warning,
+        stacklevel=2,
+    )
+    return build.make_main(argv[1:])  # skip first argument to adjust arguments (refs: #4615)
+
+
 if __name__ == '__main__':
     from .cmd import build
     warnings.warn(

sphinx/apidoc.py

@@ -21,6 +21,7 @@ def main(*args, **kwargs):
         RemovedInSphinx20Warning,
         stacklevel=2,
     )
+    args = args[1:]  # skip first argument to adjust arguments (refs: #4615)
     _main(*args, **kwargs)
 
 

sphinx/quickstart.py

@@ -22,6 +22,7 @@ def main(*args, **kwargs):
         RemovedInSphinx20Warning,
         stacklevel=2,
     )
+    args = args[1:]  # skip first argument to adjust arguments (refs: #4615)
     _main(*args, **kwargs)
 
 

utils/release-checklist

@@ -5,23 +5,23 @@ for stable releases
 -------------------
 
 * open https://travis-ci.org/sphinx-doc/sphinx/branches and check **X.Y** branch is green
-* Run `git fetch; git status` and check nothing changed
+* Run ``git fetch; git status`` and check nothing changed
-* `python utils/bump_version.py X.Y.Z`
+* ``python utils/bump_version.py X.Y.Z``
-* Check diff by `git diff`
+* Check diff by ``git diff``
 * Edit CHANGES if empty section exists
-* `git commit -am 'Bump to X.Y.Z final'`
+* ``git commit -am 'Bump to X.Y.Z final'``
-* `make clean`
+* ``make clean``
-* `python setup.py release bdist_wheel sdist upload --identity=[your key]`
+* ``python setup.py release bdist_wheel sdist upload --identity=[your key]``
 * open https://pypi.python.org/pypi/Sphinx and check there are no obvious errors
-* `git tag vX.Y.Z`
+* ``git tag vX.Y.Z``
-* `python utils/bump_version.py --in-develop X.Y.Zb0` (ex. 1.5.3b0)
+* ``python utils/bump_version.py --in-develop X.Y.Zb0`` (ex. 1.5.3b0)
 * Check diff by `git diff`
-* `git commit -am 'Bump version'`
+* ``git commit -am 'Bump version'``
-* `git push origin X.Y --tags`
+* ``git push origin X.Y --tags``
-* `git checkout master`
+* ``git checkout master``
-* `git merge X.Y`
+* ``git merge X.Y``
-* `git push origin master`
+* ``git push origin master``
-* Update `sphinx-doc-translations <https://github.com/sphinx-doc/sphinx-doc-translations>`_
+* Update ``sphinx-doc-translations <https://github.com/sphinx-doc/sphinx-doc-translations>``_
 * Add new version/milestone to tracker categories
 * Write announcement and send to sphinx-dev, sphinx-users and python-announce
 
@@ -29,28 +29,28 @@ for first beta releases
 -----------------------
 
 * open https://travis-ci.org/sphinx-doc/sphinx/branches and check **master** branch is green
-* Run `git fetch; git status` and check nothing changed
+* Run ``git fetch; git status`` and check nothing changed
-* Run `python setup.py extract_messages`
+* Run ``python setup.py extract_messages``
-* Run `(cd sphinx/locale; tx push -s)`
+* Run ``(cd sphinx/locale; tx push -s)``
-* `python utils/bump_version.py X.Y.0b1`
+* ``python utils/bump_version.py X.Y.0b1``
-* Check diff by `git diff`
+* Check diff by ``git diff``
 * Edit CHANGES if empty section exists
-* `git commit -am 'Bump to X.Y.0 beta1'`
+* ``git commit -am 'Bump to X.Y.0 beta1'``
-* `make clean`
+* ``make clean``
-* `python setup.py release bdist_wheel sdist upload --identity=[your key]`
+* ``python setup.py release bdist_wheel sdist upload --identity=[your key]``
 * open https://pypi.python.org/pypi/Sphinx and check there are no obvious errors
-* `git tag vX.Y.0b1`
+* ``git tag vX.Y.0b1``
-* `python utils/bump_version.py --in-develop X.Y.0b2` (ex. 1.6.0b2)
+* ``python utils/bump_version.py --in-develop X.Y.0b2`` (ex. 1.6.0b2)
-* Check diff by `git diff`
+* Check diff by `git diff``
-* `git commit -am 'Bump version'`
+* ``git commit -am 'Bump version'``
-* `git checkout -b X.Y`
+* ``git checkout -b X.Y``
-* `git push origin X.Y --tags`
+* ``git push origin X.Y --tags``
-* `git checkout master`
+* ``git checkout master``
-* `git merge X.Y`
+* ``git merge X.Y``
-* `python utils/bump_version.py --in-develop A.B.0b0` (ex. 1.7.0b0)
+* ``python utils/bump_version.py --in-develop A.B.0b0`` (ex. 1.7.0b0)
-* Check diff by `git diff`
+* Check diff by ``git diff``
-* `git commit -am 'Bump version'`
+* ``git commit -am 'Bump version'``
-* `git push origin master`
+* ``git push origin master``
 * Update `sphinx-doc-translations <https://github.com/sphinx-doc/sphinx-doc-translations>`_
 * Add new version/milestone to tracker categories
 * Write announcement and send to sphinx-dev, sphinx-users and python-announce
@@ -59,22 +59,22 @@ for other beta releases
 -----------------------
 
 * open https://travis-ci.org/sphinx-doc/sphinx/branches and check **X.Y** branch is green
-* Run `git fetch; git status` and check nothing changed
+* Run ``git fetch; git status`` and check nothing changed
-* `python utils/bump_version.py X.Y.0bN`
+* ``python utils/bump_version.py X.Y.0bN``
-* Check diff by `git diff`
+* Check diff by ``git diff``
 * Edit CHANGES if empty section exists
-* `git commit -am 'Bump to X.Y.0 betaN'`
+* ``git commit -am 'Bump to X.Y.0 betaN'``
-* `make clean`
+* ``make clean``
-* `python setup.py release bdist_wheel sdist upload --identity=[your key]`
+* ``python setup.py release bdist_wheel sdist upload --identity=[your key]``
 * open https://pypi.python.org/pypi/Sphinx and check there are no obvious errors
-* `git tag vX.Y.0bN`
+* ``git tag vX.Y.0bN``
-* `python utils/bump_version.py --in-develop X.Y.0bM` (ex. 1.6.0b3)
+* ``python utils/bump_version.py --in-develop X.Y.0bM`` (ex. 1.6.0b3)
-* Check diff by `git diff`
+* Check diff by `git diff``
-* `git commit -am 'Bump version'`
+* ``git commit -am 'Bump version'``
-* `git push origin X.Y --tags`
+* ``git push origin X.Y --tags``
-* `git checkout master`
+* ``git checkout master``
-* `git merge X.Y`
+* ``git merge X.Y``
-* `git push origin master`
+* ``git push origin master``
 * Update `sphinx-doc-translations <https://github.com/sphinx-doc/sphinx-doc-translations>`_
 * Add new version/milestone to tracker categories
 * Write announcement and send to sphinx-dev, sphinx-users and python-announce
@@ -83,29 +83,29 @@ for major releases
 ------------------
 
 * open https://travis-ci.org/sphinx-doc/sphinx/branches and check **X.Y** branch is green
-* Run `git fetch; git status` and check nothing changed
+* Run ``git fetch; git status`` and check nothing changed
-* Run `(cd sphinx/locale; tx pull -a -f)`
+* Run ``(cd sphinx/locale; tx pull -a -f)``
-* Run `python setup.py compile_catalog`
+* Run ``python setup.py compile_catalog``
-* Run `git add sphinx`
+* Run ``git add sphinx``
-* Run `git commit -am 'Update message catalogs'`
+* Run ``git commit -am 'Update message catalogs'``
-* `python utils/bump_version.py X.Y.0`
+* ``python utils/bump_version.py X.Y.0``
-* Check diff by `git diff`
+* Check diff by ``git diff``
 * Edit CHANGES if empty section exists
-* `git commit -am 'Bump to X.Y.0 final'`
+* ``git commit -am 'Bump to X.Y.0 final'``
-* `make clean`
+* ``make clean``
-* `python setup.py release bdist_wheel sdist upload --identity=[your key]`
+* ``python setup.py release bdist_wheel sdist upload --identity=[your key]``
 * open https://pypi.python.org/pypi/Sphinx and check there are no obvious errors
-* `git tag vX.Y.0`
+* ``git tag vX.Y.0``
-* `python utils/bump_version.py --in-develop X.Y.1b0` (ex. 1.6.1b0)
+* ``python utils/bump_version.py --in-develop X.Y.1b0`` (ex. 1.6.1b0)
-* Check diff by `git diff`
+* Check diff by ``git diff``
-* `git commit -am 'Bump version'`
+* ``git commit -am 'Bump version'``
-* `git push origin X.Y --tags`
+* ``git push origin X.Y --tags``
-* `git checkout master`
+* ``git checkout master``
-* `git merge X.Y`
+* ``git merge X.Y``
-* `git push origin master`
+* ``git push origin master``
-* `git checkout A.B` (checkout old stable)
+* ``git checkout A.B`` (checkout old stable)
-* Run `git tag A.B` to paste a tag instead branch
+* Run ``git tag A.B`` to paste a tag instead branch
-* Run `git push origin :A.B --tags` to remove old stable branch
+* Run ``git push origin :A.B --tags`` to remove old stable branch
 * open https://readthedocs.org/dashboard/sphinx/versions/ and enable the released version
 * Update `sphinx-doc-translations <https://github.com/sphinx-doc/sphinx-doc-translations>`_
 * Add new version/milestone to tracker categories