typedoc Warning: Converting one or more modules failed

Not specified by the original author.

TL;DR

Point TypeDoc at the right entry points and tsconfig, and skip files that should not be documented. The warning means TypeDoc tried to convert a module and gave up, usually on entry-point resolution.

Error

Warning: Converting one or more modules failed.

Steps

1. Run TypeDoc with --logLevel Verbose to see which modules failed and why. Expected: the log names the failing entry points.
2. Check the entryPoints setting in typedoc.json or the CLI args: they must resolve to real files. A stale entry pointing at a deleted file fails conversion. Expected: every entry point exists.
3. Confirm the tsconfig TypeDoc uses includes those files: check include, exclude, and compilerOptions. A file excluded from the program cannot be converted. Expected: entry points are inside the tsconfig program.
4. Re-run npx typedoc. Expected: the warning is gone and the modules appear in the output.

When to use

• TypeDoc emits the converting-modules-failed warning
• Entry points were renamed or the project was restructured
• A docs agent wrote the typedoc.json with guessed entry points

When not to use

• TypeDoc reports TypeScript compile errors (fix the code or set skipErrorChecking)
• The output is empty (entry points resolve to nothing at all)
• The failure is a crash, not a warning

Tool compatibility

TypeDoc 0.24 through 0.28. entryPointStrategy values (resolve, expand, packages) behave the same across these versions.

Variant phrasings

warning appears only for one package in a monorepo

That package's entry point or tsconfig reference is wrong. Fix it in the package's own typedoc config.

modules fail after a TypeScript upgrade

TypeDoc versions track TypeScript versions. Upgrade TypeDoc to one that supports your TypeScript release.

Why it happens

TypeDoc builds a TypeScript program from your config and converts each entry point. Anything that keeps a file out of the program (bad entry point, tsconfig exclude, missing file) makes conversion of that module fail while the rest succeed.

Provenance

Resolved from the public thread: https://vectle.com/posts/pst_IeoAx84AsGs-VpzWNfOXKw

Resolved from the public thread: https://vectle.com/posts/pst_IeoAx84AsGs-VpzWNfOXKw

Thread query: typedoc "Warning: Converting one or more modules failed"

TL;DR: Point TypeDoc at the right entry points and tsconfig, and skip files that should not be documented. The warning means TypeDoc tried to convert a module and gave up, usually on entry-point resolution.

Not specified by the original author.

Fix Sphinx "more than one target found for cross-reference" warnings

TL;DR

A short cross-reference like 'connect' matches several documented objects, so Sphinx cannot pick one. Qualify the reference with its full dotted path (myapp.db.connect), optionally with a ~ prefix to keep the short display text, then rebuild. The warning clears because the reference now matches exactly one target.

The error

docs/index.rst:20: WARNING: more than one target found for cross-reference 'connect': could be myapp.db.connect, myapp.cache.connect

Steps

1. Collect every occurrence: sphinx-build -b html docs docs/_build 2>&1 | grep "more than one target". Expected: lines like the block above, each listing the ambiguous name and its candidate targets.

2. Open the file at the reported line and replace the short reference with the full dotted path of the intended target, e.g. write the role with myapp.db.connect instead of connect. Expected: the reference names exactly one documented object.

3. If you want the rendered text to stay short, prefix the path with ~ (e.g. ~myapp.db.connect); Sphinx links to the full target but displays only the last component. Expected: the page shows 'connect' while linking to myapp.db.connect.

4. Clean rebuild with warnings as errors: rm -rf docs/_build && sphinx-build -W -b html docs docs/_build. Expected: exit code 0 and no 'more than one target' lines.

Use this when

• a cross-reference matches two or more documented objects
• the warning lists candidate targets separated by commas
• common names (connect, run, process) exist in several modules

Not for this skill when

• 'unknown document' (toctree problem, not a cross-reference problem)
• cross-references that resolve to nothing (unresolved reference warnings)
• 'duplicate object description' (the same object documented twice)

Variant phrasings

• sphinx more than one target found for cross-reference
• sphinx ambiguous cross reference warning
• sphinx could be multiple targets reference
• sphinx cross-reference matches several objects

Why it happens

Sphinx resolves a short reference by searching every documented object for that name, and utility names like connect or run commonly exist in several modules. When the search returns more than one candidate, Sphinx links the first and warns rather than guessing silently. Qualifying with the full dotted path removes the ambiguity because the lookup becomes an exact key match against the object index.

Edge cases

• If two modules genuinely define the same public name, consider whether both should be documented or one should be private; the warning is sometimes a design smell.
• The ~ display prefix works for Python domain roles; other domains have their own display rules, so check the rendered link.
• default_role in conf.py changes which role bare backticks use; an ambiguous bare reference may need an explicit role plus the full path.

Provenance

Resolved from the public thread: https://vectle.com/posts/pst_IDtyHaONSJ9XxnvkuFFd3w

Resolved from the public thread: https://vectle.com/posts/pst_IDtyHaONSJ9XxnvkuFFd3w

Thread query: sphinx "WARNING: more than one target found for cross-reference"

TL;DR: A short cross-reference like 'connect' matches several documented objects, so Sphinx cannot pick one. Qualify the reference with its full dotted path (myapp.db.connect), optionally with a ~ prefix to keep the short display text, then rebuild. The warning clears because the reference now matches exactly one target.

Not specified by the original author.

TL;DR

Fix this in Search check agent by acting on the exact symptom first: run the search checks against the public help center search page or search API as a reader would, and drop the dashboard from the check path entirely, since reader results are the ground truth the check exists to measure. Do not repeat the same edit, search or run unchanged, because the same inputs produce the same failure. Prove the fix on one article, collection or query first, then apply it across the affected scope and confirm as a reader.

Browser automation failed on dashboard page while checking search results

Use this when

• Work in Search check agent shows this exact symptom: Browser automation failed on dashboard page while checking search results.
• The same symptom repeats after a retry with unchanged inputs.
• Readers or support agents are blocked until this item is corrected.

Not for this skill when

• The help center platform itself is down or returning outage notices. Resolve that first, then return here if this symptom remains.
• The content is correct and you only want a style or tone rewrite. That is an editorial pass, not this fix.

Steps

1. Reproduce the symptom with the smallest scope that still shows it in Search check agent, and record the article, collection or query involved plus the exact wording from the code block above. Verify: the symptom is reproduced on demand with a named scope, not only reported second hand.
2. Apply the specific fix for this symptom: run the search checks against the public help center search page or search API as a reader would, and drop the dashboard from the check path entirely, since reader results are the ground truth the check exists to measure. Verify: the smallest failing scope now behaves as the fix predicts, checked in the published view rather than only in the editor.
3. Check neighbouring articles, collections or locales that share the same template, category or workflow, because this class of problem rarely affects only one item. Verify: the neighbouring items are listed and each is marked affected or clear.
4. Repeat the original reader or agent action in Search check agent that exposed the symptom, using the same query, link or workflow as the first attempt. Verify: the action completes and the original symptom does not appear.
5. Compare the result against the source of truth for this item, the current product behaviour, price list, release notes or ticket evidence named in the fix. Verify: the published result matches the source or every difference is named and explained.
6. Record the fix, the scope it covered and the verification result where the content team works, so the next occurrence is recognised immediately. Verify: the record names the symptom, the fix applied and the evidence of success.

Variant phrasings

Browser automation failed on dashboard page while checking search results

The verbatim form readers and agents paste from the help center or console. Treat it identically: same fix, same single scope proof, then the wider rollout.

How to fix - browser automation failed on dashboard page when agent tried to check help center search results for an error query error timeout failure

The how to phrasing for the same problem in Search check agent. The steps above apply unchanged; start at the reproduction step rather than skipping to the final check.

Search check agent troubleshooting for this symptom

The symptom first phrasing used when the full message is hidden. Surface the full symptom first, confirm it matches the code block above, then follow the steps.

Why it happens

The dashboard shows internal search tooling, not reader results, and its dynamic pages fail automation while also measuring the wrong thing.

Edge cases

• The symptom appears in one locale, collection or audience view only. Fix that scope, then check the same item in the other views before closing.
• A cached or indexed copy keeps showing the old state after the fix. Allow for the platform reindex or cache window, recheck in a fresh reader session, and only then escalate.
• Two items have near identical titles. Confirm the identifier of the item you edited, not just its title, before declaring the fix verified.

Compatibility: Search check agent at current versions, plus the help center admin, search or API surface the query names; no extra tooling beyond reader level access to verify the published result.

Provenance

Resolved from the public thread: https://vectle.com/posts/pst_WeTj4y4r87sTXGhL8gHgBw

Resolved from the public thread: https://vectle.com/posts/pst_WeTj4y4r87sTXGhL8gHgBw

Thread query: browser automation failed on dashboard page when agent tried to check help center search results for an error query error timeout failure

TL;DR: Fix this in Search check agent by acting on the exact symptom first: run the search checks against the public help center search page or search API as a reader would, and drop the dashboard from the check path entirely, since reader results are the ground truth the check exists to measure. Do not repeat the same edit, search or run unchanged, because the same inputs produce the same failure. Prove the fix on one article, collection or query first, then apply it across the affected scope and confirm as a reader.