openstack/operations-guide
Code Issues Proposed changes

Merge "Fix small mistake in setup.cfg and update packages"

Browse Source
This commit is contained in:
Zuul
2025-05-05 21:39:42 +00:00
committed by Gerrit Code Review
parent 550507fedb 33e82676b0
commit 921fe59e7a
4 changed files with 10 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.rst
View File

@@ -21,7 +21,7 @@ with it preinstalled, but you can review the `installation instructions
do not have it by default. do not have it by default.
Once git is installed, you can follow the instructions for your platform to Once git is installed, you can follow the instructions for your platform to
`install git-review <https://www.mediawiki.org/wiki/Gerrit/git-review>`_. `install git-review <https://docs.opendev.org/opendev/git-review/latest/installation.html>`_.
The last step is to configure git with your name and email address used for 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 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 Submitting Updates
------------------ ------------------
Proposing updates to the documentation is fairly straight forward once you've 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 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. couple times through. Here is a suggested workflow to help you along the way.
@@ -62,6 +63,7 @@ to the docs.openstack.org site.
Local Testing Local Testing
------------- -------------
If you would like to build the docs locally to make sure there are no issues 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 with the changes, and to view locally generated HTML files, you will need to do
a couple extra steps. a couple extra steps.

6
doc/requirements.txt
View File

@@ -1,6 +1,6 @@
# The order of packages is significant, because pip processes them in the order # 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 # of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later. # process, which may cause wedges in the gate later.
openstackdocstheme>=2.2.1 # Apache-2.0 openstackdocstheme>=3.5.0 # Apache-2.0
doc8>=0.8.1 # Apache-2.0 sphinx>=8.1.3 # BSD
sphinx>=3.5.1 # BSD doc8>=1.1.2 # Apache-2.0

6
setup.cfg
View File

@@ -2,8 +2,8 @@
name = operations-guide name = operations-guide
summary = OpenStack Operations Guide summary = OpenStack Operations Guide
author = OpenStack author = OpenStack
author-email = openstack-discuss@lists.openstack.org author_email = openstack-discuss@lists.openstack.org
home-page = https://docs.openstack.org/operations-guide home_page = https://docs.openstack.org/operations-guide
classifier = classifier =
Environment :: OpenStack Environment :: OpenStack
Intended Audience :: Information Technology Intended Audience :: Information Technology
@@ -11,5 +11,3 @@ classifier =
License :: OSI Approved :: Apache Software License License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux Operating System :: POSIX :: Linux
Topic :: Documentation Topic :: Documentation
[files]

4
tox.ini
View File

@@ -1,11 +1,9 @@
[tox] [tox]
minversion = 4.0 minversion = 4.4
skipsdist = True skipsdist = True
envlist = docs envlist = docs
[testenv] [testenv]
basepython = python3
setenv = VIRTUAL_ENV={envdir}
passenv = passenv =
*_proxy *_proxy
*_PROXY *_PROXY