IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fix documented default values for setuptools integration.

Browse Source 
The defaults were obtained by reading the implementation in
`setup_command.py`, notably `_guess_source_dir` and `finalize_options`.
This commit is contained in:
Antony Lee 2017-09-01 22:28:49 -07:00
parent cb0220de1a
commit cfa03b9771
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/setuptools.rst
View File

@ -82,7 +82,9 @@ Options for setuptools integration
.. confval:: source-dir .. confval:: source-dir
The target source directory. This can be relative to the ``setup.py`` or The target source directory. This can be relative to the ``setup.py`` or
``setup.cfg`` file, or it can be absolute. Default is ``''``. ``setup.cfg`` file, or it can be absolute. It defaults to ``./doc`` or
``./docs`` if either contains a file named ``conf.py`` (checking ``./doc``
first); otherwise it defaults to the current directory.
This can also be set by passing the `-s` flag to ``setup.py``: This can also be set by passing the `-s` flag to ``setup.py``:
@ -93,13 +95,13 @@ Options for setuptools integration
.. confval:: build-dir .. confval:: build-dir
The target build directory. This can be relative to the ``setup.py`` or The target build directory. This can be relative to the ``setup.py`` or
``setup.cfg`` file, or it can be absolute. Default is ``''``. ``setup.cfg`` file, or it can be absolute. Default is ``./build/sphinx``.
.. confval:: config-dir .. confval:: config-dir
Location of the configuration directory. This can be relative to the Location of the configuration directory. This can be relative to the
``setup.py`` or ``setup.cfg`` file, or it can be absolute. Default is ``setup.py`` or ``setup.cfg`` file, or it can be absolute. Default is to use
``''``. `source-dir`.
This can also be set by passing the `-c` flag to ``setup.py``: This can also be set by passing the `-c` flag to ``setup.py``: