sphinx-contrib / sphinx-contrib/openapi

Could not import extension sphinxcontrib.openapi

Open
#129 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
126
Forks
88
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the import failure with the listed Sphinx 5.2.3, sphinxcontrib-openapi 0.7.0, and docutils 0.19 environment, starting at the sphinxcontrib.openapi extension import and docutils.core reference. Check the project’s package metadata and compatibility guidance; done means establishing supported versions or a clearly scoped compatibility fix.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, python
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.