summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorStefan H. Holek <stefan@epy.co.at>2012-10-19 04:15:58 +0200
committerStefan H. Holek <stefan@epy.co.at>2012-10-19 04:15:58 +0200
commit0a1a4cdedb6bfd3e1fc2121275dd765c597e33ed (patch)
tree503026cd7b7729b34657fdd6a15b4235300e44d6 /docs
parent197c1c33644d1bae8e58f0fbdbd33b387d8ec0bb (diff)
downloadpython-setuptools-git-0a1a4cdedb6bfd3e1fc2121275dd765c597e33ed.tar.gz
Update CHANGES and docs.
--HG-- branch : distribute extra : rebase_source : e24a57706eebda4c1f989467a0a3bc951f550dd4
Diffstat (limited to 'docs')
-rw-r--r--docs/setuptools.txt7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/setuptools.txt b/docs/setuptools.txt
index 31eedcb1..81c3aae3 100644
--- a/docs/setuptools.txt
+++ b/docs/setuptools.txt
@@ -2423,7 +2423,12 @@ command::
python setup.py upload_docs --upload-dir=docs/build/html
-As with any other ``setuptools`` based command, you can define useful
+If no ``--upload-dir`` is given, ``upload_docs`` will attempt to run the
+``build_sphinx`` command to generate uploadable documentation.
+For the command to become available, `Sphinx <http://sphinx.pocoo.org/>`_
+must be installed in the same environment as distribute.
+
+As with other ``setuptools``-based commands, you can define useful
defaults in the ``setup.cfg`` of your Python project, e.g.:
.. code-block:: ini