Skip to content

mkdoxy error while reading ~ as ‾ #149

@Moddimation

Description

@Moddimation

Hi there! I am trying to use this plugin for a SHIFT JIS codebase.
It does give me following error, both when I specify SHIFT JIS as input encoding, or when I make a copy with all files converted to UTF:

Traceback (most recent call last): File "<frozen runpy>", line 198, in _run_module_as_main File "<frozen runpy>", line 88, in _run_code File "/usr/lib/python3.13/site-packages/mkdocs/__main__.py", line 370, in <module> cli() ~~~^^ File "/usr/lib/python3.13/site-packages/click/core.py", line 1442, in __call__ return self.main(*args, **kwargs) ~~~~~~~~~^^^^^^^^^^^^^^^^^ File "/usr/lib/python3.13/site-packages/click/core.py", line 1363, in main rv = self.invoke(ctx) File "/usr/lib/python3.13/site-packages/click/core.py", line 1830, in invoke return _process_result(sub_ctx.command.invoke(sub_ctx)) ~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^ File "/usr/lib/python3.13/site-packages/click/core.py", line 1226, in invoke return ctx.invoke(self.callback, **ctx.params) ~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/lib/python3.13/site-packages/click/core.py", line 794, in invoke return callback(*args, **kwargs) File "/usr/lib/python3.13/site-packages/mkdocs/__main__.py", line 288, in build_command build.build(cfg, dirty=not clean) ~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^ File "/usr/lib/python3.13/site-packages/mkdocs/commands/build.py", line 292, in build files = config.plugins.on_files(files, config=config) File "/usr/lib/python3.13/site-packages/mkdocs/plugins.py", line 593, in on_files return self.run_event('files', files, config=config) ~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/lib/python3.13/site-packages/mkdocs/plugins.py", line 566, in run_event result = method(item, **kwargs) File "/home/dima/.local/lib/python3.13/site-packages/mkdoxy/plugin.py", line 159, in on_files generatorAuto.fullDoc(project_config) ~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^ File "/home/dima/.local/lib/python3.13/site-packages/mkdoxy/generatorAuto.py", line 80, in fullDoc self.index( ~~~~~~~~~~^ self.doxygen.root.children, ^^^^^^^^^^^^^^^^^^^^^^^^^^^ ...<3 lines>... defaultTemplateConfig, ^^^^^^^^^^^^^^^^^^^^^^ ) ^ File "/home/dima/.local/lib/python3.13/site-packages/mkdoxy/generatorAuto.py", line 288, in index output = self.generatorBase.index(nodes, kind_filters, kind_parents, title, config) File "/home/dima/.local/lib/python3.13/site-packages/mkdoxy/generatorBase.py", line 501, in index dictionary[found.name_tokens[-1][0].lower()].append(found) ~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ KeyError: '‾' )

Debugging leads me to the conclusion that somehow the tilde "~" symbol from my C++ destructor was turned into this "‾" symbol, which causes this mkdoxy error. How do I solve this? My goal is that the ~ symbol is read as a ~ symbol, and is put into the docs that way.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions