trivial: Remove references to Python 2.7
There were some in both the docs and the demo application. Change-Id: I58d14cd3a372f9bdf617cbfbcb5ce34169ac83f8 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
This commit is contained in:
parent
bc76d324f5
commit
37e53cad85
@ -26,16 +26,15 @@ setup(
|
|||||||
url='https://github.com/openstack/cliff',
|
url='https://github.com/openstack/cliff',
|
||||||
download_url='https://github.com/openstack/cliff/tarball/master',
|
download_url='https://github.com/openstack/cliff/tarball/master',
|
||||||
|
|
||||||
classifiers=['Development Status :: 3 - Alpha',
|
classifiers=[
|
||||||
'License :: OSI Approved :: Apache Software License',
|
'Development Status :: 3 - Alpha',
|
||||||
'Programming Language :: Python',
|
'License :: OSI Approved :: Apache Software License',
|
||||||
'Programming Language :: Python :: 2',
|
'Programming Language :: Python',
|
||||||
'Programming Language :: Python :: 2.7',
|
'Programming Language :: Python :: 3',
|
||||||
'Programming Language :: Python :: 3',
|
'Programming Language :: Python :: 3 :: Only',
|
||||||
'Programming Language :: Python :: 3.2',
|
'Intended Audience :: Developers',
|
||||||
'Intended Audience :: Developers',
|
'Environment :: Console',
|
||||||
'Environment :: Console',
|
],
|
||||||
],
|
|
||||||
|
|
||||||
platforms=['Any'],
|
platforms=['Any'],
|
||||||
|
|
||||||
|
@ -16,68 +16,40 @@ Pull requests submitted through GitHub will be ignored.
|
|||||||
|
|
||||||
Bugs should be filed under the `Storyboard project`_.
|
Bugs should be filed under the `Storyboard project`_.
|
||||||
|
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
Before contributing new features to clif core, please consider
|
Before contributing new features to clif core, please consider
|
||||||
whether they should be implemented as an extension instead. The
|
whether they should be implemented as an extension instead. The
|
||||||
architecture is highly pluggable precisely to keep the core small.
|
architecture is highly pluggable precisely to keep the core small.
|
||||||
|
|
||||||
Building Documentation
|
|
||||||
======================
|
|
||||||
|
|
||||||
The documentation for cliff is written in reStructuredText and
|
|
||||||
converted to HTML using Sphinx. The build itself is driven by make.
|
|
||||||
You will need the following packages in order to build the docs:
|
|
||||||
|
|
||||||
- Sphinx
|
|
||||||
- docutils
|
|
||||||
|
|
||||||
Once all of the tools are installed into a virtualenv using
|
|
||||||
pip, run ``make docs`` to generate the HTML version of the
|
|
||||||
documentation::
|
|
||||||
|
|
||||||
$ make docs
|
|
||||||
(cd docs && make clean html)
|
|
||||||
sphinx-build -b html -d build/doctrees source build/html
|
|
||||||
Running Sphinx v1.1.3
|
|
||||||
loading pickled environment... done
|
|
||||||
building [html]: targets for 1 source files that are out of date
|
|
||||||
updating environment: 1 added, 1 changed, 0 removed
|
|
||||||
reading sources... [100%] index
|
|
||||||
looking for now-outdated files... none found
|
|
||||||
pickling environment... done
|
|
||||||
done
|
|
||||||
preparing documents... done
|
|
||||||
writing output... [100%] index
|
|
||||||
writing additional files... genindex search
|
|
||||||
copying static files... done
|
|
||||||
dumping search index... done
|
|
||||||
dumping object inventory... done
|
|
||||||
build succeeded, 2 warnings.
|
|
||||||
|
|
||||||
Build finished. The HTML pages are in build/html.
|
|
||||||
|
|
||||||
The output version of the documentation ends up in
|
|
||||||
``./docs/build/html`` inside your sandbox.
|
|
||||||
|
|
||||||
Running Tests
|
Running Tests
|
||||||
=============
|
=============
|
||||||
|
|
||||||
The test suite for clif uses tox_, which must be installed separately
|
The test suite for cliff uses tox_, which must be installed separately
|
||||||
(``pip install tox``).
|
(``pip install tox``).
|
||||||
|
|
||||||
To run the tests under Python 2.7 and 3.3 as well as PyPy, run ``tox``
|
To run the standard set of tests, run ``tox`` from the top level directory of
|
||||||
from the top level directory of the git repository.
|
the git repository.
|
||||||
|
|
||||||
To run tests under a single version of Python, specify the appropriate
|
To run a single environment, specify it using the ``-e`` parameter. For
|
||||||
environment when running tox::
|
example::
|
||||||
|
|
||||||
$ tox -e py27
|
$ tox -e pep8
|
||||||
|
|
||||||
Add new tests by modifying an existing file or creating new script in
|
Add new tests by modifying an existing file or creating new script in
|
||||||
the ``tests`` directory.
|
the ``tests`` directory.
|
||||||
|
|
||||||
.. _tox: http://codespeak.net/tox
|
.. _tox: https://tox.readthedocs.io/
|
||||||
|
|
||||||
|
Building Documentation
|
||||||
|
======================
|
||||||
|
|
||||||
|
The documentation for cliff is written in reStructuredText and
|
||||||
|
converted to HTML using Sphinx. Like tests, the documentation can be built
|
||||||
|
using ``tox``::
|
||||||
|
|
||||||
|
$ tox -e docs
|
||||||
|
|
||||||
|
The output version of the documentation ends up in ``./docs/build/html``.
|
||||||
|
|
||||||
.. _developer-templates:
|
.. _developer-templates:
|
||||||
|
Loading…
Reference in New Issue
Block a user