diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/contributor/index.rst | 2 | ||||
| -rw-r--r-- | doc/source/user/features.rst | 14 | ||||
| -rw-r--r-- | doc/source/user/using.rst | 12 |
3 files changed, 16 insertions, 12 deletions
diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index b7b4a75..95daead 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -27,7 +27,7 @@ are listed in ``requirements.txt`` and the requirements for testing are in pip install -r requirements.txt -r test-requirements.txt -In you go this route, you can interact with the testr command directly. +If you go this route, you can interact with the testr command directly. Running ``testr run`` will run the entire test suite. ``testr run --parallel`` will run it in parallel (this is the default incantation tox uses). More information about testr can be found at: http://wiki.openstack.org/testr diff --git a/doc/source/user/features.rst b/doc/source/user/features.rst index 80339df..46c9d03 100644 --- a/doc/source/user/features.rst +++ b/doc/source/user/features.rst @@ -181,6 +181,10 @@ probably a good long_description. So we'll just inject the contents of your You can also specify the exact file you want to use using the ``description-file`` parameter. +You can set the ``description-content-type`` to a MIME type that may +help rendering of the description; for example ``text/markdown`` or +``text/x-rst; charset=UTF-8``. + Requirements ~~~~~~~~~~~~ @@ -200,14 +204,16 @@ for your project and will then parse these files, split them up appropriately, and inject them into the ``install_requires``, ``tests_require`` and/or ``dependency_links`` arguments to ``setup``. Voila! -You can also have a requirement file for each specific major version of Python. -If you want to have a different package list for Python 3 then just drop a -``requirements-py3.txt`` and it will be used instead. - Finally, it is possible to specify groups of optional dependencies, or :ref:`"extra" requirements <extra-requirements>`, in your ``setup.cfg`` rather than ``setup.py``. +.. versionchanged:: 5.0 + + Previously you could specify requirements for a given major version of + Python using requirments files with a ``-pyN`` suffix. This was deprecated + in 4.0 and removed in 5.0 in favour of environment markers. + Automatic File Generation ------------------------- diff --git a/doc/source/user/using.rst b/doc/source/user/using.rst index 2917e92..2e58fee 100644 --- a/doc/source/user/using.rst +++ b/doc/source/user/using.rst @@ -389,20 +389,18 @@ Requirements Requirements files are used in place of the ``install_requires`` and ``extras_require`` attributes. Requirement files should be given one of the -below names. This order is also the order that the requirements are tried in -(where ``N`` is the Python major version number used to install the package): +below names. This order is also the order that the requirements are tried in: -* ``requirements-pyN.txt`` -* ``tools/pip-requires-py3`` * ``requirements.txt`` * ``tools/pip-requires`` Only the first file found is used to install the list of packages it contains. -.. note:: +.. versionchanged:: 5.0 - The ``requirements-pyN.txt`` file is deprecated - ``requirements.txt`` - should be universal. You can use `Environment markers`_ for this purpose. + Previously you could specify requirements for a given major version of + Python using requirements files with a ``-pyN`` suffix. This was deprecated + in 4.0 and removed in 5.0 in favour of environment markers. .. _extra-requirements: |