I opened a PR here that prints a deprecation warning message (below) when running the index subcommand.
The
indexcommand is deprecated and scheduled to be removed after the Swift 6.6 release; pass the--emit-lmdb-indexflag to theconvertcommand instead
The
convertcommand always creates a JSON representation of the navigation hierarchy for the on-page sidebar.
If you need an LMDB database representation of the same navigation hierarchy, pass the--emit-lmdb-indexflag to theconvertcommand instead of running theindexcommand on the output of theconvertcommand.If you're building documentation using the Swift-DocC Plugin (
swift package generate-documentation) it passes the--emit-lmdb-indexflag to Swift-DocC by default, and requires the--disable-indexing/--no-indexingflag to opt out of that behavior. If you need the LMDB database representation of the same navigation hierarchy in the documentation output, don't pass the--disable-indexing/--no-indexingflag toswift package generate-documentation.
The idea is to also cherry-pick that change into the 6.4 release so that the deprecation message reaches developers sooner—to give any developer who uses this command but doesn't read the Swift Forums as much time as possible to both reach out about their use case and/or to transition to passing the the --emit-lmdb-index flag instead.