Missing settings documentation

[marcopetri98]

Hi,

I noticed the README doesn't currently mention how to configure the Zed editor to use this extension. To help Zed users get up and running quickly, I suggest adding a short "Zed Setup" section to the documentation.

For context, here is the required configuration for settings.json to get the LSP working properly:

{
  "languages": {
    "Python": {
      "language_servers": ["...", "python-autodoc-lsp"]
    }
  }
}

If this looks good to you, I'd be happy to open a quick Pull Request to update the README with these instructions!

[eallender]

Hi Marco! Thanks for bringing this to my attention. I don't believe I had to add this to my settings when I installed, but I also just realized my autodoc-lsp is no longer working. I'm wondering if there was a Zed change that now requires this?

If you'd like to open a PR that would be great! Otherwise I can look into it more this evening.

[eallender]

Just following up, the lsp seems to be working fine upon installation without any additions to the settings.json. The extension should automatically register the language server for Python, so you shouldn't normally need to add that setting manually.

Would you mind sharing a few details about your setup so I can try to reproduce it?

• Operating system (Windows/macOS/Linux)
• Zed version
• Did you install the extension from the extension marketplace or build it locally
• Did you have any custom Python language settings in your settings.json (languages.Python.language_servers as mentioned above) that existed before installation
• Any messages in the Zed logs related to python-autodoc-lsp or the extension

Also, does the extension not work at all without the settings change, or does the language server simply never start? Any screenshots or log output would be very helpful.

Thanks!

[marcopetri98]

Hi Evan,

sure I can give you this info such that we can try to understand which is the problem behind this. Here are the information you are requesting for reproducing it:

• Operating system: Windows 11 Pro, version 25H2
• Zed Version: 1.9.0 (precisely, 1.9.0+stable.316.ced90fc636c4ede05402befc38a63bae7fd741bd)
• I installed the extension from the marketplace
• Yes I had, I am using Ruff and Basedpyright, I'll copy below my settings before python autodoc installation.
• Nothing popped up by Zed. I also opened Zed logs and I don't find errors related to autodoc, but I see that when I add it to the settings.json and reload workspace, I get the following logs stating it is starting. Otherwise, nothing.

However, even though the issue persists (Zed automatically updated this morning), it was already present before updating itself automatically. Therefore, it is a problem that is persisting since the previous version, however, I do not recall what was that, I think 1.8.x.

Previously existing LSP Python settings:

"languages": {
  "YAML": {
    "tab_size": 2,
  },
  "Python": {
    "language_servers": ["ruff", "!ty", "basedpyright"],
    "formatter": {
      "language_server": {
        "name": "ruff",
      },
    },
  },
},

Logs when adding python autodoc to language servers:

2026-07-02T11:16:48+02:00 INFO  [project::lsp_store] language server 3: unregistered workspace/DidChangeWatchedFiles capability with id dcd20e2d-65d8-4760-a104-f070939c0ab1
2026-07-02T11:20:43+02:00 INFO  [project::lsp_store] language server 3: unregistered workspace/DidChangeWatchedFiles capability with id 3c0ce5ac-d096-4dac-9d6e-f8afff890556
2026-07-02T11:20:45+02:00 INFO  [project::lsp_store] language server 3: unregistered workspace/DidChangeWatchedFiles capability with id b6006014-e2f6-4a16-85e4-69495c92062e
2026-07-02T11:20:54+02:00 INFO  [zed::reliability] memory usage: resident 305 MiB (+24 MiB), virtual 404 MiB
2026-07-02T11:21:09+02:00 INFO  [project::lsp_store] language server 3: unregistered workspace/DidChangeWatchedFiles capability with id 5c23ccc1-3c4f-4655-8006-51d1c9d6fbae
2026-07-02T11:21:14+02:00 INFO  [project::prettier_store] Starting prettier at path "C:\\Users\\__USER__\\AppData\\Local\\Zed\\prettier"
2026-07-02T11:21:14+02:00 INFO  [lsp] starting language server process. binary path: "C:\\Users\\__USER__\\AppData\\Local\\Zed\\node\\node-v24.11.0-win-x64\\node.exe", working directory: "C:\\Users\\__USER__\\AppData\\Local\\Zed\\prettier", args: ["C:\\Users\\__USER__\\AppData\\Local\\Zed\\prettier\\prettier_server.js", "C:\\Users\\__USER__\\AppData\\Local\\Zed\\prettier"]
2026-07-02T11:21:15+02:00 INFO  [project::prettier_store] Started default prettier in "C:\\Users\\__USER__\\AppData\\Local\\Zed\\prettier"
2026-07-02T11:21:15+02:00 INFO  [lsp] starting language server process. binary path: "C:\\Users\\__USER__\\AppData\\Local\\Zed\\extensions\\work\\python-autodoc-lsp\\python-autodoc-lsp.exe\\python-autodoc-lsp.exe", working directory: "C:\\Users\\__USER__\\repos\\__MYPROJECTNAME__", args: []
2026-07-02T11:21:16+02:00 INFO  [project::lsp_store] language server 3: unregistered workspace/DidChangeWatchedFiles capability with id 4e7d5657-12ae-49d2-9acd-d83a6c66ba05

I replaced my OS username and project directory folder name with placeholders.

[eallender]

Thanks! That was super helpful. I believe the issue here is your initial settings.json file.
When you set the language servers in a closed list like this: "language_servers": ["ruff", "!ty", "basedpyright"], it will prevent any language servers you install from being automatically started for the desired language.
Including "...", like you mentioned in your initial message is the recommended way to match all other registered language servers not mentioned in your defined list as a wildcard.

Typically by default, you would not have any language servers specified and the lsp would be started automatically when you open a file of the corresponding language (which is how I have my settings configured).
Seems this matches the described behavior in the zed docs.

I will add a troubleshooting page to the docs just in case anyone else runs into this same problem.

Thanks!