From 67d9a7711b5926729267aa9652b705ef769d7be3 Mon Sep 17 00:00:00 2001 From: jacky06 Date: Tue, 18 Jun 2019 22:17:56 +0800 Subject: [PATCH] Sync Sphinx requirement 1. Sync sphinx dependency with global requirements. It caps python 2 since sphinx 2.0 no longer supports Python 2.7. 2. Update some URLs to latest Change-Id: I12ab3ba42683f9f75189ab597b9768ae5ec7a3fb --- README.rst | 2 +- api-quick-start/source/api-quick-start.rst | 2 +- api-quick-start/source/index.rst | 4 ++-- test-requirements.txt | 3 ++- 4 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 8cb609563..cb8607185 100644 --- a/README.rst +++ b/README.rst @@ -33,7 +33,7 @@ Prerequisites ============= To build the documentation locally, you must install Python and -`Python Tox `_. +`Python Tox `_. To install Tox for Ubuntu 14.04 or later:: diff --git a/api-quick-start/source/api-quick-start.rst b/api-quick-start/source/api-quick-start.rst index 096aaa01e..b645d8989 100644 --- a/api-quick-start/source/api-quick-start.rst +++ b/api-quick-start/source/api-quick-start.rst @@ -444,7 +444,7 @@ Install the clients Use ``pip`` to install the OpenStack clients on a Mac OS X or Linux system. It is easy and ensures that you get the latest version of the client from the -`Python Package Index `__. Also, ``pip`` lets you +`Python Package Index `__. Also, ``pip`` lets you update or remove a package. You must install the client for each project separately, but the diff --git a/api-quick-start/source/index.rst b/api-quick-start/source/index.rst index a9448205f..1a16e792d 100644 --- a/api-quick-start/source/index.rst +++ b/api-quick-start/source/index.rst @@ -120,7 +120,7 @@ Deprecated API versions API quick-start examples ------------------------ -With the `TryStack `__ OpenStack +With the `TryStack `__ OpenStack installation, these services work together in the background of the installation, and many of these examples work on TryStack. @@ -148,7 +148,7 @@ To begin sending API requests, use one of the following methods: for REST. For Firefox, see `RESTClient `__. For Chrome, see - `rest-client `__. + `rest-client `__. - **OpenStack Python Software Development Kit (SDK)** diff --git a/test-requirements.txt b/test-requirements.txt index b94601a89..a72b8beaa 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -8,7 +8,8 @@ openstack-doc-tools>=1.8.0 # Apache-2.0 doc8 # Apache-2.0 Pygments -sphinx>=1.6.2 # BSD +sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD +sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD openstackdocstheme>=1.18.1 # Apache-2.0 nwdiag