docs: fix mkdocstrings refs after terratorch-iterate merge#320
Merged
Conversation
The terratorch-iterate merge moved its modules from the 'benchmark' package to 'terratorch_iterate', but the mkdocstrings ::: directives in the docs still referenced 'benchmark.*'. This broke 'mkdocs build' (and therefore the versioned docs deploy) with ModuleNotFoundError. Update all directives in index.md, ray.md, and repeating_experiments.md to 'terratorch_iterate.*'. Verified 'mkdocs build' now succeeds. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Romeo Kienzler <romeo.kienzler1@ibm.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The v0.5.0 versioned-docs deploy failed (and
mkdocs buildwas failing locally too) with:The terratorch-iterate merge moved those modules from the
benchmarkpackage toterratorch_iterate, but the mkdocstrings:::directives in the docs still pointed atbenchmark.*.Fix
Update all stale directives to
terratorch_iterate.*across:docs/index.md(backbone_benchmark, benchmark_types.*)docs/ray.md(benchmark_ray.benchmark_backbone)docs/repeating_experiments.md(repeat_best_experiment.rerun_best_from_backbone)Verified locally:
mkdocs buildnow exits 0 and producessite/index.html.Follow-up
After merge, the docs workflow will re-publish
devcleanly. I'll also re-run thev0.5.0docs deploy viaworkflow_dispatchso the released version's docs build (it failed on release because of this bug).🤖 Generated with Claude Code