feat: Allow disabling the language server

[pieterlexis]

Hello Lua-LS maintainers,

This PR adds the option to set lua_ls to disable. This will make the plugin not download or run any language server.

The usecase for this is the following. Our software (PowerDNS) has Lua as scripting language/hook engine embedded in our software. These Lua functions and objects are wrapped C++ objects and functions and hence we ship no Lua files. We do want to document all these objects and functions using the Sphinx/rst Lua domain for easy cross referencing in the docs. As this means we don't need to run a Language Server, it seemed a good idea to allow not running this.

If you need any changes to this PR, let me know.

Best regards,

Pieter Lexis

[taminomara]

Thanks for the PR.

Please, add checks to warn and early returns to run_apidoc and autoobject, otherwise they'll fail with somewhat obscure error.

Also, run pre-commit run --all to fix codestyle.

Other than this, everything else looks fine!

[pieterlexis]

Please, add checks to warn and early returns to run_apidoc and autoobject, otherwise they'll fail with somewhat obscure error.

I'm not a sphinx expert, whereabouts would the early return for autoobject go? Is it in AutodocUtilsMixin.render? Thanks for any hints you may have.

Also, run pre-commit run --all to fix codestyle.

Will do!

Other than this, everything else looks fine!

Great!

[taminomara]

I'm not a sphinx expert, whereabouts would the early return for autoobject go? Is it in AutodocUtilsMixin.render? Thanks for any hints you may have.

In AutoObjectDirective.run, before prepare_options. You can do raise self.error("...").

[pieterlexis]

Excellent, I added the returns/errors and now sphinx produces these errors when autodoc is enabled in conf.py and an .. autoobject:: is used:

[taminomara]

One last thing 😸

[taminomara]

Merged, will release in a few days.