From 33e82676b091b165681f6a3dbc04ea3ff8b4b5c8 Mon Sep 17 00:00:00 2001 From: Ivan Anfimov Date: Mon, 5 May 2025 20:52:34 +0000 Subject: [PATCH] Fix small mistake in setup.cfg and update packages Change-Id: If69edf62f784d3208551a3e8cb80f1a442c43c61 --- README.rst | 6 ++++-- doc/requirements.txt | 6 +++--- setup.cfg | 6 ++---- tox.ini | 4 +--- 4 files changed, 10 insertions(+), 12 deletions(-) diff --git a/README.rst b/README.rst index d3dde567..af7445b1 100644 --- a/README.rst +++ b/README.rst @@ -21,7 +21,7 @@ with it preinstalled, but you can review the `installation instructions do not have it by default. Once git is installed, you can follow the instructions for your platform to -`install git-review `_. +`install git-review `_. The last step is to configure git with your name and email address used for your Gerrit account set up so it can link you patch to your user. Run the @@ -35,6 +35,7 @@ following to set these values: Submitting Updates ------------------ + Proposing updates to the documentation is fairly straight forward once you've done it, but there are a few steps that can appear intimidating your first couple times through. Here is a suggested workflow to help you along the way. @@ -43,7 +44,7 @@ couple times through. Here is a suggested workflow to help you along the way. git clone https://opendev.org/openstack/operations-guide cd operations-guide - + # it is useful to make changes on a separate branch in case you need to make # other changes git checkout -b my-topic @@ -62,6 +63,7 @@ to the docs.openstack.org site. Local Testing ------------- + If you would like to build the docs locally to make sure there are no issues with the changes, and to view locally generated HTML files, you will need to do a couple extra steps. diff --git a/doc/requirements.txt b/doc/requirements.txt index 814ec044..81b275e3 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,6 +1,6 @@ # The order of packages is significant, because pip processes them in the order # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -openstackdocstheme>=2.2.1 # Apache-2.0 -doc8>=0.8.1 # Apache-2.0 -sphinx>=3.5.1 # BSD +openstackdocstheme>=3.5.0 # Apache-2.0 +sphinx>=8.1.3 # BSD +doc8>=1.1.2 # Apache-2.0 diff --git a/setup.cfg b/setup.cfg index c778a4a4..d1649b9c 100644 --- a/setup.cfg +++ b/setup.cfg @@ -2,8 +2,8 @@ name = operations-guide summary = OpenStack Operations Guide author = OpenStack -author-email = openstack-discuss@lists.openstack.org -home-page = https://docs.openstack.org/operations-guide +author_email = openstack-discuss@lists.openstack.org +home_page = https://docs.openstack.org/operations-guide classifier = Environment :: OpenStack Intended Audience :: Information Technology @@ -11,5 +11,3 @@ classifier = License :: OSI Approved :: Apache Software License Operating System :: POSIX :: Linux Topic :: Documentation - -[files] diff --git a/tox.ini b/tox.ini index 5381c839..5a1acda8 100644 --- a/tox.ini +++ b/tox.ini @@ -1,11 +1,9 @@ [tox] -minversion = 4.0 +minversion = 4.4 skipsdist = True envlist = docs [testenv] -basepython = python3 -setenv = VIRTUAL_ENV={envdir} passenv = *_proxy *_PROXY