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
commit3775323d44a9b64dad2410da543d6017dfd9f0ca (patch)
tree4f313dac09b4eca182252daa37fde94d3ff816f6 /docs
parented6afd104698ab15d93bf52b590b5b19dc84d602 (diff)
downloadpython-setuptools-bitbucket-3775323d44a9b64dad2410da543d6017dfd9f0ca.tar.gz
Update CHANGES and docs.
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