mkdocstrings-twincat handler usage example

philippleidig commented 2 weeks ago

I try to use the mkdocs plugin or mkdocstrings handler, but fail after several attempts with the same error message.

ERROR - Error reading page 'index.md': No module named 'mkdocstrings_handlers.python'

Packages mkdocstrings and mkdocstrings-twincat are successfully installed. Are there any instructions on how to use the handler? 😇

mkdocs.yml

plugins:
  - mkdocstrings:
      handlers:
        twincat:
          options:
            show_signature: true
            show_source: true
      default_handler: null

index.md

::: twincat
    path: FB_Axis.TcPOU
    show_signature: true
    show_source: true

Thanks for the help 🙂

drehstromer commented 1 week ago

Hi @philippleidig

Unfortunately, this package isnt working right now. I wanted to develop this for my codebase, but it got lost in my todo-list. I still want to get this working but with work and school, its a bit hard... If you want to help, we can have a discussion about how i envision this handler. I hope i find some time to work on it in the next few weeks/months.

philippleidig commented 2 days ago

To be honest, I lack the Python knowledge to be able to contribute something productive here 😄

drehstromer / mkdocstrings-twincat

mkdocstrings-twincat handler usage example #1