openstack/python-novaclient
Code Issues Proposed changes

[doc] change directive noindex to no-index

Browse Source 
Due to a bug in Sphinx [1], the ':noindex:' flag is currently broken for
the 'module' directive. Workaround it by replacing it with the ':no-index'
flag, which is what we'll need come Sphinx 9.x anyway.

[1] https://github.com/sphinx-doc/sphinx/issues/12843

Change-Id: If3fa5c51b566ea0144acf84d186ce12c8127c9a8
This commit is contained in:
Elod Illes 2024-08-29 17:20:52 +02:00 committed by Stephen Finucane
parent 3e63fb9dd9
commit bc7db06629
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/user/python-api.rst
View File

@ -4,7 +4,7 @@
.. module:: novaclient .. module:: novaclient
:synopsis: A client for the OpenStack Nova API. :synopsis: A client for the OpenStack Nova API.
:noindex: :no-index:
.. currentmodule:: novaclient .. currentmodule:: novaclient