openstack/python-glanceclient
Code Issues Proposed changes

Docs generation: mock the six module for autodoc

Browse Source 
Currently, tox-edocs fails with the following error message:

Warning, treated as error:
autodoc: failed to import module 'shell' from module 'glanceclient'; the
following exception was raised:
No module named 'six'

We used to install six in the virtual environment through keystoneauth,
but keystoneauth no longer depends on six. Let's mock six completely in
the context of autodoc.

Change-Id: Ibcf0b9698227a2c22fe991b7516ba5dceabfc607
This commit is contained in:
Cyril Roelandt 2023-06-07 17:19:28 +02:00
parent 8681124fcc
commit 7c2ab837aa
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/source/conf.py
View File

@ -46,6 +46,9 @@ openstackdocs_bug_tag = ''
# text edit cycles. # text edit cycles.
# execute "export SPHINX_DEBUG=1" in your terminal to disable # execute "export SPHINX_DEBUG=1" in your terminal to disable
# TODO: remove this once no dependency uses six anymore
autodoc_mock_imports = ['six']
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']