Error: ModuleNotFoundError: No module named 'mkdocstrings_handlers

[rodrwankenobi]

Im getting following error:

ModuleNotFoundError: No module named 'mkdocstrings_handlers

This is my mkdocs.yml:

site_name: Extrator PDF SMA
theme: readthedocs
plugins:
  - search
  - mkdocstrings:
      python:
        setup_commands:
          - import sys
          - sys.path.append('../')
        selection:
          new_path_syntax: true

mkdocs, version 1.5.3

[pawamoy]

What version of mkdocstrings and mkdocstrings-python (or mkdocstrings-python-legacy) do you have? Also please post the complete command output, in verbose mode (mkdocs serve -v or mkdocs build -v). Also your config is wrong, python should appear under handlers.

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          setup_commands:
            - import sys
            - sys.path.append('../')
          selection:
            new_path_syntax: true

[rodrwankenobi]

mkdocs 1.5.3
mkdocstrings 0.23.0
python 3.11.1

Command output

DEBUG   -  Loading configuration file: C:\Users\rodri\Documents\sma_pdf\docs\mkdocs.yml
DEBUG   -  Loaded theme configuration for 'readthedocs' from 'C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\themes\readthedocs\mkdocs_theme.yml':           {'static_templates': ['404.html'], 'locale': 'en', 'include_search_page': True, 'search_index_only': False, 'highlightjs': True, 'hljs_languages': [],       
           'hljs_style': 'github', 'analytics': {'gtag': None, 'anonymize_ip': False}, 'include_homepage_in_sidebar': True, 'prev_next_buttons_location': 'bottom',     
           'navigation_depth': 4, 'titles_only': False, 'sticky_navigation': True, 'collapse_navigation': True, 'logo': None}
DEBUG   -  Config value 'config_file_path' = 'C:\\Users\\rodri\\Documents\\sma_pdf\\docs\\mkdocs.yml'
DEBUG   -  Config value 'site_name' = 'Extrator PDF SMA'
DEBUG   -  Config value 'nav' = None
DEBUG   -  Config value 'pages' = None
DEBUG   -  Config value 'exclude_docs' = None
DEBUG   -  Config value 'not_in_nav' = None
DEBUG   -  Config value 'site_url' = None
DEBUG   -  Config value 'site_description' = None
DEBUG   -  Config value 'site_author' = None
DEBUG   -  Config value 'theme' = Theme(name='readthedocs', dirs=['C:\\Users\\rodri\\AppData\\Roaming\\Python\\Python311\\site-packages\\mkdocs\\themes\\readthedocs',  
           'C:\\Users\\rodri\\AppData\\Roaming\\Python\\Python311\\site-packages\\mkdocs\\templates'], static_templates={'404.html', 'sitemap.xml'}, name='readthedocs',           locale=Locale('en'), include_search_page=True, search_index_only=False, highlightjs=True, hljs_languages=[], hljs_style='github', analytics={'gtag': None,   
           'anonymize_ip': False}, include_homepage_in_sidebar=True, prev_next_buttons_location='bottom', navigation_depth=4, titles_only=False, sticky_navigation=True,           collapse_navigation=True, logo=None)
DEBUG   -  Config value 'docs_dir' = 'C:\\Users\\rodri\\Documents\\sma_pdf\\docs\\docs'
DEBUG   -  Config value 'site_dir' = 'C:\\Users\\rodri\\AppData\\Local\\Temp\\mkdocs_0a70jye9'
DEBUG   -  Config value 'copyright' = None
DEBUG   -  Config value 'google_analytics' = None
DEBUG   -  Config value 'dev_addr' = _IpAddressValue(host='127.0.0.1', port=8000)
DEBUG   -  Config value 'use_directory_urls' = True
DEBUG   -  Config value 'repo_url' = None
DEBUG   -  Config value 'repo_name' = None
DEBUG   -  Config value 'edit_uri_template' = None
DEBUG   -  Config value 'edit_uri' = None
DEBUG   -  Config value 'extra_css' = []
DEBUG   -  Config value 'extra_javascript' = []
DEBUG   -  Config value 'extra_templates' = []
DEBUG   -  Config value 'markdown_extensions' = ['toc', 'tables', 'fenced_code']
DEBUG   -  Config value 'mdx_configs' = {}
DEBUG   -  Config value 'strict' = False
DEBUG   -  Config value 'remote_branch' = 'gh-pages'
DEBUG   -  Config value 'remote_name' = 'origin'
DEBUG   -  Config value 'extra' = {}
DEBUG   -  Config value 'plugins' = {'search': <mkdocs.contrib.search.SearchPlugin object at 0x0000014C37614610>, 'mkdocstrings':
           <mkdocstrings.plugin.MkdocstringsPlugin object at 0x0000014C3761BE10>}
DEBUG   -  Config value 'hooks' = {}
DEBUG   -  Config value 'watch' = []
DEBUG   -  Config value 'validation' = {'nav': {'omitted_files': 20, 'not_found': 30, 'absolute_links': 20}, 'links': {'not_found': 30, 'absolute_links': 20,
           'unrecognized_links': 20}}
INFO    -  Building documentation...
DEBUG   -  Running 2 `config` events
DEBUG   -  mkdocstrings: Adding extension to the list
DEBUG   -  mkdocstrings: Added a subdued autorefs instance <mkdocs_autorefs.plugin.AutorefsPlugin object at 0x0000014C37760350>
DEBUG   -  mkdocs_autorefs: Adding AutorefsExtension to the list
DEBUG   -  Running 1 `pre_build` events
INFO    -  Cleaning site directory
DEBUG   -  Looking for translations for locale 'en'
DEBUG   -  No translations found here: 'C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\contrib\search\templates\locales'
DEBUG   -  No translations found here: 'C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\templates\locales'
DEBUG   -  No translations found here: 'C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\themes\readthedocs\locales'
DEBUG   -  Reading markdown pages.
DEBUG   -  Reading: extrator.md
DEBUG   -  Running 1 `page_markdown` events
DEBUG   -  mkdocstrings: Matched '::: sma_pdf.extrator.Extrator'
DEBUG   -  mkdocstrings: Using handler 'python'
ERROR   -  Error reading page 'extrator.md': No module named 'mkdocstrings_handlers'
Traceback (most recent call last):
  File "<frozen runpy>", line 198, in _run_module_as_main
  File "<frozen runpy>", line 88, in _run_code
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\Scripts\mkdocs.exe\__main__.py", line 7, in <module>
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\click\core.py", line 1130, in __call__
    return self.main(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\click\core.py", line 1055, in main
    rv = self.invoke(ctx)
         ^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\click\core.py", line 1657, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\click\core.py", line 1404, in invoke
    return ctx.invoke(self.callback, **ctx.params)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\click\core.py", line 760, in invoke
    return __callback(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\__main__.py", line 270, in serve_command
    serve.serve(**kwargs)
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\commands\serve.py", line 86, in serve
    builder(config)
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\commands\serve.py", line 67, in builder
    build(config, live_server=None if is_clean else server, dirty=is_dirty)
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\commands\build.py", line 322, in build
    _populate_page(file.page, config, files, dirty)
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\commands\build.py", line 175, in _populate_page
    page.render(config, files)
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\structure\pages.py", line 271, in render
    self.content = md.convert(self.markdown)
                   ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\markdown\core.py", line 264, in convert
    root = self.parser.parseDocument(self.lines).getroot()
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\markdown\blockparser.py", line 90, in parseDocument
    self.parseChunk(self.root, '\n'.join(lines))
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\markdown\blockparser.py", line 105, in parseChunk
    self.parseBlocks(parent, text.split('\n\n'))
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\markdown\blockparser.py", line 123, in parseBlocks
       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocstrings\extension.py", line 125, in run
    html, handler, data = self._process_block(identifier, block, heading_level)
                          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocstrings\extension.py", line 196, in _process_block
    handler = self._handlers.get_handler(handler_name, handler_config)
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocstrings\handlers\base.py", line 458, in get_handler
    module = importlib.import_module(f"mkdocstrings_handlers.{name}")
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Program Files\Python311\Lib\importlib\__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "<frozen importlib._bootstrap>", line 1206, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1178, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1128, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "<frozen importlib._bootstrap>", line 1206, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1178, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1142, in _find_and_load_unlocked
ModuleNotFoundError: No module named 'mkdocstrings_handlers'
PS C:\Users\rodri\Documents\sma_pdf\docs> mkdocs serve -v
DEBUG   -  Loading configuration file: C:\Users\rodri\Documents\sma_pdf\docs\mkdocs.yml
DEBUG   -  Loaded theme configuration for 'readthedocs' from 'C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\themes\readthedocs\mkdocs_theme.yml':           {'static_templates': ['404.html'], 'locale': 'en', 'include_search_page': True, 'search_index_only': False, 'highlightjs': True, 'hljs_languages': [],       
           'hljs_style': 'github', 'analytics': {'gtag': None, 'anonymize_ip': False}, 'include_homepage_in_sidebar': True, 'prev_next_buttons_location': 'bottom',     
           'navigation_depth': 4, 'titles_only': False, 'sticky_navigation': True, 'collapse_navigation': True, 'logo': None}
DEBUG   -  Config value 'config_file_path' = 'C:\\Users\\rodri\\Documents\\sma_pdf\\docs\\mkdocs.yml'
DEBUG   -  Config value 'site_name' = 'Extrator PDF SMA'
DEBUG   -  Config value 'nav' = None
DEBUG   -  Config value 'pages' = None
DEBUG   -  Config value 'exclude_docs' = None
DEBUG   -  Config value 'not_in_nav' = None
DEBUG   -  Config value 'site_url' = None
DEBUG   -  Config value 'site_description' = None
DEBUG   -  Config value 'site_author' = None
DEBUG   -  Config value 'theme' = Theme(name='readthedocs', dirs=['C:\\Users\\rodri\\AppData\\Roaming\\Python\\Python311\\site-packages\\mkdocs\\themes\\readthedocs',  
           'C:\\Users\\rodri\\AppData\\Roaming\\Python\\Python311\\site-packages\\mkdocs\\templates'], static_templates={'404.html', 'sitemap.xml'}, name='readthedocs',           locale=Locale('en'), include_search_page=True, search_index_only=False, highlightjs=True, hljs_languages=[], hljs_style='github', analytics={'gtag': None,   
           'anonymize_ip': False}, include_homepage_in_sidebar=True, prev_next_buttons_location='bottom', navigation_depth=4, titles_only=False, sticky_navigation=True,           collapse_navigation=True, logo=None)
DEBUG   -  Config value 'docs_dir' = 'C:\\Users\\rodri\\Documents\\sma_pdf\\docs\\docs'
DEBUG   -  Config value 'site_dir' = 'C:\\Users\\rodri\\AppData\\Local\\Temp\\mkdocs_8g88thdt'
DEBUG   -  Config value 'copyright' = None
DEBUG   -  Config value 'google_analytics' = None
DEBUG   -  Config value 'dev_addr' = _IpAddressValue(host='127.0.0.1', port=8000)
DEBUG   -  Config value 'use_directory_urls' = True
DEBUG   -  Config value 'repo_url' = None
DEBUG   -  Config value 'repo_name' = None
DEBUG   -  Config value 'edit_uri_template' = None
DEBUG   -  Config value 'edit_uri' = None
DEBUG   -  Config value 'extra_css' = []
DEBUG   -  Config value 'extra_javascript' = []
DEBUG   -  Config value 'extra_templates' = []
DEBUG   -  Config value 'markdown_extensions' = ['toc', 'tables', 'fenced_code']
DEBUG   -  Config value 'mdx_configs' = {}
DEBUG   -  Config value 'strict' = False
DEBUG   -  Config value 'remote_branch' = 'gh-pages'
DEBUG   -  Config value 'remote_name' = 'origin'
DEBUG   -  Config value 'extra' = {}
DEBUG   -  Config value 'plugins' = {'search': <mkdocs.contrib.search.SearchPlugin object at 0x000001A001E32790>, 'mkdocstrings':
           <mkdocstrings.plugin.MkdocstringsPlugin object at 0x000001A001E3F9D0>}
DEBUG   -  Config value 'hooks' = {}
DEBUG   -  Config value 'watch' = []
DEBUG   -  Config value 'validation' = {'nav': {'omitted_files': 20, 'not_found': 30, 'absolute_links': 20}, 'links': {'not_found': 30, 'absolute_links': 20,
           'unrecognized_links': 20}}
INFO    -  Building documentation...
DEBUG   -  Running 2 `config` events
DEBUG   -  mkdocstrings: Adding extension to the list
DEBUG   -  mkdocstrings: Added a subdued autorefs instance <mkdocs_autorefs.plugin.AutorefsPlugin object at 0x000001A0027800D0>
DEBUG   -  mkdocs_autorefs: Adding AutorefsExtension to the list
DEBUG   -  Running 1 `pre_build` events
INFO    -  Cleaning site directory
DEBUG   -  Looking for translations for locale 'en'
DEBUG   -  No translations found here: 'C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\contrib\search\templates\locales'
DEBUG   -  No translations found here: 'C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\templates\locales'
DEBUG   -  No translations found here: 'C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\themes\readthedocs\locales'
DEBUG   -  Reading markdown pages.
DEBUG   -  Reading: extrator.md
DEBUG   -  Running 1 `page_markdown` events
DEBUG   -  mkdocstrings: Matched '::: sma_pdf.extrator.Extrator'
DEBUG   -  mkdocstrings: Using handler 'python'
ERROR   -  Error reading page 'extrator.md': No module named 'mkdocstrings_handlers'
Traceback (most recent call last):
  File "<frozen runpy>", line 198, in _run_module_as_main
  File "<frozen runpy>", line 88, in _run_code
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\Scripts\mkdocs.exe\__main__.py", line 7, in <module>
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\click\core.py", line 1130, in __call__
    return self.main(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\click\core.py", line 1055, in main
    rv = self.invoke(ctx)
         ^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\click\core.py", line 1657, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\click\core.py", line 1404, in invoke
    return ctx.invoke(self.callback, **ctx.params)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\click\core.py", line 760, in invoke
    return __callback(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\__main__.py", line 270, in serve_command
    serve.serve(**kwargs)
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\commands\serve.py", line 86, in serve
    builder(config)
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\commands\serve.py", line 67, in builder
    build(config, live_server=None if is_clean else server, dirty=is_dirty)
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\commands\build.py", line 322, in build
    _populate_page(file.page, config, files, dirty)
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\commands\build.py", line 175, in _populate_page
    page.render(config, files)
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocs\structure\pages.py", line 271, in render
    self.content = md.convert(self.markdown)
                   ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\markdown\core.py", line 264, in convert
    root = self.parser.parseDocument(self.lines).getroot()
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\markdown\blockparser.py", line 90, in parseDocument
    self.parseChunk(self.root, '\n'.join(lines))
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\markdown\blockparser.py", line 105, in parseChunk
    self.parseBlocks(parent, text.split('\n\n'))
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\markdown\blockparser.py", line 123, in parseBlocks
    if processor.run(parent, blocks) is not False:
       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocstrings\extension.py", line 125, in run
    html, handler, data = self._process_block(identifier, block, heading_level)
                          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocstrings\extension.py", line 196, in _process_block
    handler = self._handlers.get_handler(handler_name, handler_config)
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rodri\AppData\Roaming\Python\Python311\site-packages\mkdocstrings\handlers\base.py", line 458, in get_handler
    module = importlib.import_module(f"mkdocstrings_handlers.{name}")
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Program Files\Python311\Lib\importlib\__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "<frozen importlib._bootstrap>", line 1206, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1178, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1128, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "<frozen importlib._bootstrap>", line 1206, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1178, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1142, in _find_and_load_unlocked
ModuleNotFoundError: No module named 'mkdocstrings_handlers'

[rodrwankenobi]

My mkdocs.yml

site_name: Extrator PDF SMA
theme: readthedocs
python_version: 3.7
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          setup_commands:
            - import sys
            - sys.path.append('../')
          selection:
            new_path_syntax: true

[pawamoy]

Thanks, what about the versions of mkdocstrings-python or mkdocstrings-python-legacy? Is one of them actually installed?

[rodrwankenobi]

[pawamoy]

Thanks. So you're indeed missing the mkdocstrings-python or mkdocstrings-python-legacy dependency.

[rodrwankenobi]

it works, thank you very much!