openstack
/
os-api-ref
Code Issues Proposed changes

Replace 'add_stylesheet', 'add_javascript' 

We currently see the following warnings when building a doc project
involving os-api-ref:

  RemovedInSphinx40Warning: The app.add_stylesheet() is deprecated.
  Please use app.add_css_file() instead.
  RemovedInSphinx40Warning: The app.add_javascript() is deprecated.
  Please use app.add_js_file() instead.

As the message would suggest, these methods were replaced by
'add_css_file' and 'add_js_file' in commits 3afc72fb [1] and f3168d98
[2], respectively. Both changes were first included in Sphinx 1.8, which
is lower than our current minimum, so there's no need to bump
requirements.

[1] https://github.com/sphinx-doc/sphinx/commit/3afc72fb
[2] https://github.com/sphinx-doc/sphinx/commit/f3168d98

Change-Id: I7f4d772adbcb9d592935b14c430ae3a62a60b6d1
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This commit is contained in:
Stephen Finucane 2020-12-07 11:21:31 +00:00
parent adb453580a
commit 1e639fd5a2
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
os_api_ref/__init__.py
View File

@ -655,9 +655,9 @@ def copy_assets(app, exception):
def add_assets(app):
app.add_stylesheet('api-site.css')
app.add_javascript('api-site.js')
app.add_javascript('combobox.js')
app.add_css_file('api-site.css')
app.add_js_file('api-site.js')
app.add_js_file('combobox.js')
def setup(app):