summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMonty Taylor <mordred@inaugust.com>2018-01-31 10:43:18 -0600
committerMonty Taylor <mordred@inaugust.com>2018-01-31 11:34:57 -0600
commit5dbfc60fdee9bcf98d53455b54ba7295e40f8705 (patch)
tree8e74fd55b7ab70ba7c4836cca90648a7f19d5f8f /doc
parentc9b8ead15ac25fa52992ac6c5762c7fcaa58fce1 (diff)
downloados-client-config-5dbfc60fdee9bcf98d53455b54ba7295e40f8705.tar.gz
Split docs requirements and update tox.ini
Get ourselves up to date with the latest in PTI hotness. Change-Id: Ied98273dcfa0b9622d603a8e9a8e2146fb1e081f
Diffstat (limited to 'doc')
-rw-r--r--doc/requirements.txt4
-rw-r--r--doc/source/install/index.rst2
-rw-r--r--doc/source/user/configuration.rst14
3 files changed, 12 insertions, 8 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000..5715746
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,4 @@
+docutils>=0.11 # OSI-Approved Open Source, Public Domain
+sphinx!=1.6.6,>=1.6.2 # BSD
+openstackdocstheme>=1.18.1 # Apache-2.0
+reno>=2.5.0 # Apache-2.0
diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst
index 48bbc2f..cb31b25 100644
--- a/doc/source/install/index.rst
+++ b/doc/source/install/index.rst
@@ -9,4 +9,4 @@ At the command line::
Or, if you have virtualenvwrapper installed::
$ mkvirtualenv os-client-config
- $ pip install os-client-config \ No newline at end of file
+ $ pip install os-client-config
diff --git a/doc/source/user/configuration.rst b/doc/source/user/configuration.rst
index df0b266..54a829a 100644
--- a/doc/source/user/configuration.rst
+++ b/doc/source/user/configuration.rst
@@ -9,8 +9,8 @@ Environment Variables
provide backwards compatibility to service-specific variables such as
`NOVA_USERNAME`.
-If you have OpenStack environment variables set, `os-client-config` will produce
-a cloud config object named `envvars` containing your values from the
+If you have OpenStack environment variables set, `os-client-config` will
+produce a cloud config object named `envvars` containing your values from the
environment. If you don't like the name `envvars`, that's ok, you can override
it by setting `OS_CLOUD_NAME`.
@@ -115,11 +115,11 @@ location rules previously mentioned for the config files.
`regions` can be a list of regions. When you call `get_all_clouds`,
you'll get a cloud config object for each cloud/region combo.
-As seen with `dns_service_type`, any setting that makes sense to be per-service,
-like `service_type` or `endpoint` or `api_version` can be set by prefixing
-the setting with the default service type. That might strike you funny when
-setting `service_type` and it does me too - but that's just the world we live
-in.
+As seen with `dns_service_type`, any setting that makes sense to be
+per-service, like `service_type` or `endpoint` or `api_version` can be set by
+prefixing the setting with the default service type. That might strike you
+funny when setting `service_type` and it does me too - but that's just the
+world we live in.
Auth Settings
-------------