Fix document rendering and update 2025.1 cycle testing

This commit fixes two issues:

1. Fixing document rendering

2. Update the testing as per the 2025.1 cycle testing[1]
by adding a new job to run on Jammy which can be removed
in future cycle. Also, ignore E231 checks in pep8 job.

[1] https://governance.openstack.org/tc/reference/runtimes/2025.1.html

Change-Id: Id9f8171349ca017f0dfdd640b6fa88ee27c943c3
Signed-off-by: Takashi Natsume <takanattie@gmail.com>

.zuul.yaml

@@ -57,6 +57,14 @@
     parent: masakari-functional-devstack
     description: |
       Masakari functional tests job based on devstack (two-node).
+    nodeset: openstack-two-node-noble
+
+- job:
+    name: masakari-functional-devstack-multinode-jammy
+    voting: false
+    parent: masakari-functional-devstack
+    description: |
+      Masakari functional tests job based on devstack (Jammy two-node).
     nodeset: openstack-two-node-jammy
 
 - job:
@@ -91,11 +99,13 @@
       jobs:
         - openstack-tox-linters
         - masakari-functional-devstack-multinode
+        - masakari-functional-devstack-multinode-jammy
         - masakari-functional-devstack-ipv6
     gate:
       jobs:
         - openstack-tox-linters
         - masakari-functional-devstack-multinode
+        - masakari-functional-devstack-multinode-jammy
         - masakari-functional-devstack-ipv6
     periodic:
       jobs:

doc/source/contributor/release_notes.rst

@@ -66,7 +66,7 @@ Templates and examples
 
 All approved release notes end up being published on a dedicated site:
 
-   https://docs.openstack.org/releasenotes/masakari/
+https://docs.openstack.org/releasenotes/masakari/
 
 When looking for examples, it is advised to consider browsing the page above
 for a similar type of change and then comparing with their source

doc/source/index.rst

@@ -108,10 +108,10 @@ Reference Material
 
    * If you are a new contributor to Masakari please refer: :doc:`contributor/contributing`
 
-      .. toctree::
-         :hidden:
+   .. toctree::
+      :hidden:
 
-         contributor/contributing
+      contributor/contributing
 
    Search
    ======

doc/source/install/overview.rst

@@ -15,17 +15,17 @@ KVM-based Virtual Machines(VM) from a failure events described below:
   evacuate all the VMs from failure host according to the following recovery
   methods (use nova evacuate API).
 
-    * ``auto`` -
-      evacuate all the VMs with no destination node for nova scheduler.
-    * ``reserved_host`` -
-      evacuate all the VMs with reserved hosts as the destination nodes for
-      nova scheduler.
-    * ``auto_priority`` -
-      evacuate all the VMs by using ``auto`` recovery method firstly.
-      If failed, then using ``reserved_host`` recovery method.
-    * ``rh_priority`` -
-      evacuate all the VMs by using ``reserved_host`` recovery method firstly.
-      If failed, then using ``auto`` recovery method.
+  * ``auto`` -
+    evacuate all the VMs with no destination node for nova scheduler.
+  * ``reserved_host`` -
+    evacuate all the VMs with reserved hosts as the destination nodes for
+    nova scheduler.
+  * ``auto_priority`` -
+    evacuate all the VMs by using ``auto`` recovery method firstly.
+    If failed, then using ``reserved_host`` recovery method.
+  * ``rh_priority`` -
+    evacuate all the VMs by using ``reserved_host`` recovery method firstly.
+    If failed, then using ``auto`` recovery method.
 
 The below services enables deplores to integrate with the Masakari directly
 or through custom plug-ins.

masakari/conf/api.py

@@ -28,15 +28,15 @@ specified as the username.
 
 * Possible values:
 
-    Either 'keystone' (default) or 'noauth2'.
+  Either 'keystone' (default) or 'noauth2'.
 
 * Services that use this:
 
-    ``masakari-api``
+  ``masakari-api``
 
 * Related options:
 
-    None
+  None
 """),
     cfg.BoolOpt("use_forwarded_for",
                 default=False,
@@ -48,15 +48,15 @@ You should only enable this if you have an HTML sanitizing proxy.
 
 * Possible values:
 
-    True, False (default)
+  True, False (default)
 
 * Services that use this:
 
-    ``masakari-api``
+  ``masakari-api``
 
 * Related options:
 
-    None
+  None
 """),
 ]
 
@@ -70,15 +70,15 @@ maximum number of items in a single response by setting this option.
 
 * Possible values:
 
-    Any positive integer. Default is 1000.
+  Any positive integer. Default is 1000.
 
 * Services that use this:
 
-    ``masakari-api``
+  ``masakari-api``
 
 * Related options:
 
-    None
+  None
 """),
     cfg.StrOpt("osapi_masakari_link_prefix",
                help="""
@@ -88,15 +88,15 @@ unchanged.
 
 * Possible values:
 
-    Any string, including an empty string (the default).
+  Any string, including an empty string (the default).
 
 * Services that use this:
 
-    ``masakari-api``
+  ``masakari-api``
 
 * Related options:
 
-    None
+  None
 """),
 ]
 

masakari/conf/base.py

@@ -27,7 +27,7 @@ Determine if monkey patching should be applied.
 
 Related options:
 
-  * ``monkey_patch_modules``: This must have values set for this option to have
+* ``monkey_patch_modules``: This must have values set for this option to have
   any effect
 """),
     cfg.ListOpt(
@@ -41,8 +41,8 @@ modules.
 
 Related options:
 
-  * ``monkey_patch``: This must be set to ``True`` for this option to
-    have any effect
+* ``monkey_patch``: This must be set to ``True`` for this option to
+  have any effect
 """),
 ]
 

masakari/conf/engine.py

@@ -32,16 +32,16 @@ whenever an RPC call to the masakari engine is made.
 
 * Possible values:
 
-    Any string, but there is almost never any reason to ever change this value
-    from its default of 'engine'.
+  Any string, but there is almost never any reason to ever change this value
+  from its default of 'engine'.
 
 * Services that use this:
 
-    ``masakari-engine``
+  ``masakari-engine``
 
 * Related options:
 
-    None
+  None
 """),
 ]
 

masakari/conf/osapi_v1.py

@@ -31,16 +31,16 @@ always accessible.
 
 * Possible values:
 
-    A list of strings, each being the alias of an extension that you do not
-    wish to load.
+  A list of strings, each being the alias of an extension that you do not
+  wish to load.
 
 * Services that use this:
 
-    ``masakari-api``
+  ``masakari-api``
 
 * Related options:
 
-    enabled, extensions_whitelist
+  enabled, extensions_whitelist
 """),
     cfg.ListOpt("extensions_whitelist",
                 default=[],
@@ -58,16 +58,16 @@ extensions will be part of the standard API, and thus always accessible.
 
 * Possible values:
 
-    A list of strings, each being the alias of an extension that you wish to
-    load, or an empty list, which indicates that all extensions are to be run.
+  A list of strings, each being the alias of an extension that you wish to
+  load, or an empty list, which indicates that all extensions are to be run.
 
 * Services that use this:
 
-    ``masakari-api``
+  ``masakari-api``
 
 * Related options:
 
-    enabled, extensions_blacklist
+  enabled, extensions_blacklist
 """),
     cfg.StrOpt("project_id_regex",
                default=None,
@@ -82,15 +82,15 @@ created by keystone.
 
 * Possible values:
 
-    A string representing any legal regular expression
+  A string representing any legal regular expression
 
 * Services that use this:
 
-    ``masakari-api``
+  ``masakari-api``
 
 * Related options:
 
-    None
+  None
 """),
 ]
 

masakari/tests/unit/db/test_migrations.py

@@ -79,7 +79,7 @@ class MigrationsWalk(
         if revision not in self.init_versions:
             self.assertIsNotNone(
                 check_method,
-                f"DB Migration {revision} doesn't have a test; add one"
+                f"DB Migration {revision} doesn't have a test, add one"
             )
 
         pre_upgrade = getattr(self, f'_pre_upgrade_{revision}', None)

tox.ini

@@ -137,10 +137,11 @@ show-source = True
 # The below hacking rules by default are disabled should be enabled:
 # [H106] Don't put vim configuration in source files.
 # [H203] Use assertIs(Not)None to check for None.
+# [E231] missing whitespace after ','
 # [H904] Delay string interpolations at logging calls.
 enable-extensions = H106,H203,H904
 # [W504] line break after binary operator (use W503 instead)
-ignore = E123,E125,E128,E731,H405,W504
+ignore = E123,E125,E128,E231,E731,H405,W504
 builtins = _
 exclude = .venv,.git,.tox,dist,doc,*lib/python*,*egg,build