sphinx-contrib / openapi

OpenAPI (fka Swagger) spec renderer for Sphinx.
https://sphinxcontrib-openapi.readthedocs.io
BSD 2-Clause "Simplified" License
111 stars 81 forks source link

Could not import extension sphinxcontrib.openapi #129

Open msm-sardar opened 2 years ago

msm-sardar commented 2 years ago

I cannot import sphinxcontrib.openapi because of docutils.core. Can you please tell me which versions of sphinx, sphinxcontrib.openapi, and docutils I should use?

Here is the error:

Running Sphinx v5.2.3

Extension error:
Could not import extension sphinxcontrib.openapi (exception: cannot import name 'ErrorString' from 'docutils.core' (c:\users\msa75\documents\repos\batterysimm-val-api\api-dev-guide\.venv\lib\site-packages\docutils\core.py))

here are the packages I have in the environment:

Package                       Version
----------------------------- ---------
alabaster                     0.7.12
attrs                         22.1.0
Babel                         2.10.3
certifi                       2022.9.24
charset-normalizer            2.1.1
colorama                      0.4.5
docutils                      0.19
idna                          3.4
imagesize                     1.4.1
importlib-metadata            5.0.0
importlib-resources           5.9.0
Jinja2                        3.1.2
jsonschema                    4.16.0
m2r                           0.2.1
MarkupSafe                    2.1.1
mistune                       2.0.4
packaging                     21.3
pip                           22.2.2
pkgutil_resolve_name          1.3.10
Pygments                      2.13.0
pyparsing                     3.0.9
pyrsistent                    0.18.1
pytz                          2022.4
PyYAML                        6.0
requests                      2.28.1
setuptools                    40.8.0
six                           1.16.0
snowballstemmer               2.2.0
Sphinx                        5.2.3
sphinxcontrib-applehelp       1.0.2
sphinxcontrib-devhelp         1.0.2
sphinxcontrib-htmlhelp        2.0.0
sphinxcontrib-httpdomain      1.8.0
sphinxcontrib-jsmath          1.0.1
sphinxcontrib-openapi         0.7.0
sphinxcontrib-qthelp          1.0.3
sphinxcontrib-serializinghtml 1.1.5
typing_extensions             4.4.0
urllib3                       1.26.12
zipp                          3.8.1
UsamaSadiq commented 2 years ago

The combination Sphinx==5.2.3(latest), docutils==0.18.1 and sphinxcontrib-openapi==0.7.0 worked for me. I had to pin the docutils<0.19 due to sphinxcontrib-openapi. For further details, please have a look at the PR.