From bb3888e73e8bcbdc2340309a85a5f57a0c5bccf0 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Sun, 19 Apr 2020 09:54:27 +0200
Subject: [PATCH] Update docs building
Update docs building:
* Switch to sphinx-build
* Update requirements for Sphinx and openstackdocstheme for
python 3
* Remove unneeded doc and translation sections from setup.cfg
* Remove install_command, it's unneeded, the default is fine.
Change-Id: Ib9fe754b700bceb164ba0f596cbcc6d864ccbadc
---
doc/requirements.txt | 4 ++--
lower-constraints.txt | 4 ++--
setup.cfg | 12 ------------
tox.ini | 3 +--
4 files changed, 5 insertions(+), 18 deletions(-)
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 6cdad2ab..3ee9fc2a 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,5 +1,5 @@
keystoneauth1>=3.4.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,<2.0.0,>=1.6.2;python_version=='2.7' # BSD
-sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
+sphinx>=2.0.0,!=2.1.0;python_version>='3.4' # BSD
reno>=2.5.0 # Apache-2.0
-openstackdocstheme>=1.20.0 # Apache-2.0
+openstackdocstheme>=1.31.2 # Apache-2.0
diff --git a/lower-constraints.txt b/lower-constraints.txt
index ead02791..1e4ffb90 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -20,7 +20,7 @@ MarkupSafe==1.0
mccabe==0.2.1
mock==1.2.0
netaddr==0.7.10
-openstackdocstheme==1.20.0
+openstackdocstheme==2.0.0
openstacksdk==0.11.0
oslo.config==1.2.0
pbr==2.0.0
@@ -37,7 +37,7 @@ reno==2.5.0
requests==1.1.0
six==1.9.0
snowballstemmer==1.2.1
-sphinx==1.6.2
+sphinx==2.0.0
sphinxcontrib-websupport==1.0.1
stestr==2.0.0
testtools==2.2.0
diff --git a/setup.cfg b/setup.cfg
index bcb4d223..3ce8e637 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -20,10 +20,6 @@ classifier =
Programming Language :: Python :: 3.6
Programming Language :: Python :: 3.7
-[global]
-setup-hooks =
- pbr.hooks.setup_hook
-
[files]
packages =
swiftclient
@@ -43,14 +39,6 @@ console_scripts =
keystoneauth1.plugin =
v1password = swiftclient.authv1:PasswordLoader
-[build_sphinx]
-source-dir = doc/source
-build-dir = doc/build
-all_files = 1
-
-[upload_sphinx]
-upload-dir = doc/build/html
-
[bdist_wheel]
universal = 1
diff --git a/tox.ini b/tox.ini
index 2b4f6e36..8a50bb16 100644
--- a/tox.ini
+++ b/tox.ini
@@ -5,7 +5,6 @@ skipsdist = True
[testenv]
usedevelop = True
-install_command = python -m pip install -U {opts} {packages}
list_dependencies_command = python -m pip freeze
setenv =
LANG=en_US.utf-8
@@ -68,7 +67,7 @@ basepython = python3
usedevelop = False
deps = -r{toxinidir}/doc/requirements.txt
commands=
- python setup.py build_sphinx -W
+ sphinx-build -W -b html doc/source doc/build/html -W
[flake8]
# it's not a bug that we aren't using all of hacking, ignore: