Update doc links

ajalt · May 18, 2024 · 6cad28a · 6cad28a
1 parent 17cf8ad
commit 6cad28a
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 27 deletions.
diff --git a/docs/advanced.md b/docs/advanced.md
@@ -577,14 +577,14 @@ TerminalInterface](#replacing-stdin-and-stdout), or you can call [parse][parse]
 * [file][file] and [path][path] parameter types are not supported.
 
 [BaseCliktCommand]:              api/clikt/com.github.ajalt.clikt.core/-base-clikt-command/index.html
-[CliktCommand]:                  api/clikt/com.github.ajalt.clikt.core/-clikt-command/index.html
+[CliktCommand]:                  api/clikt-mordant/com.github.ajalt.clikt.core/-clikt-command/index.html
 [CommandLineParser]:             api/clikt/com.github.ajalt.clikt.parsers/-command-line-parser/index.html
 [CommandLineParser.main]:        api/clikt/com.github.ajalt.clikt.parsers/-command-line-parser/main.html
 [CommandLineParser.parse]:       api/clikt/com.github.ajalt.clikt.parsers/-command-line-parser/parse.html
 [CommandLineParser.parseAndRun]: api/clikt/com.github.ajalt.clikt.parsers/-command-line-parser/parse-and-run.html
 [Flow]:                          https://kotlinlang.org/docs/flow.html
 [ProgramResult]:                 api/clikt/com.github.ajalt.clikt.core/-program-result/index.html
-[SuspendingCliktCommand]:        api/clikt/com.github.ajalt.clikt.command/-suspending-clikt-command/index.html
+[SuspendingCliktCommand]:        api/clikt-mordant/com.github.ajalt.clikt.command/-suspending-clikt-command/index.html
 [TermUI]:                        api/clikt/com.github.ajalt.clikt.output/-term-ui/index.html
 [aliases]:                       api/clikt/com.github.ajalt.clikt.core/-base-clikt-command/aliases.html
 [callOnClose]:                   api/clikt/com.github.ajalt.clikt.core/-context/call-on-close.html
@@ -599,8 +599,8 @@ TerminalInterface](#replacing-stdin-and-stdout), or you can call [parse][parse]
 [main]:                          api/clikt/com.github.ajalt.clikt.core/main.html
 [parse]:                         api/clikt/com.github.ajalt.clikt.core/parse.html
 [path]:                          api/clikt/com.github.ajalt.clikt.parameters.types/path.html
-[prompt]:                        api/clikt/com.github.ajalt.clikt.parameters.options/prompt.html
+[prompt]:                        api/clikt-mordant/com.github.ajalt.clikt.parameters.options/prompt.html
 [registerCloseable]:             api/clikt/com.github.ajalt.clikt.core/register-closeable.html
 [registerJvmCloseable]:          api/clikt/com.github.ajalt.clikt.core/register-jvm-closeable.html
-[test]:                          api/clikt/com.github.ajalt.clikt.testing/test.html
+[test]:                          api/clikt-mordant/com.github.ajalt.clikt.testing/test.html
 [tokenTransformer]:              api/clikt/com.github.ajalt.clikt.core/-context/token-transformer.html
diff --git a/docs/commands.md b/docs/commands.md
@@ -203,7 +203,7 @@ functions, and they'll look for an object with that key and type in the context'
 Keep in mind that the [`findOrSetObject`][findOrSetObject] property is lazy and won't set the
 Context's `obj` until its value is accessed. If you need to set an object for subcommands without
 accessing the property, you should use [`currentContext.findOrSetObject`][Context.findOrSetObject],
-or set [`currentContext.obj`][Context.obj] or [`Context.Builder.obj`][builder.obj] directly,
+or set [`currentContext.obj`][Context.obj] or [`Context.Builder.obj`][Context.obj] directly,
 instead.
 
 === "Eager initialization with findOrSetObject"
@@ -517,11 +517,10 @@ applies a series of transformations to it, printing the final result:
     ```
 
 [argument.multiple]:             api/clikt/com.github.ajalt.clikt.parameters.arguments/multiple.html
-[builder.obj]:                   api/clikt/com.github.ajalt.clikt.core/-context/-builder/obj.html
-[ChainedCliktCommand]:           api/clikt/com.github.ajalt.clikt.command/-chained-clikt-command/index.html
-[CliktCommand]:                  api/clikt/com.github.ajalt.clikt.core/-clikt-command/index.html
+[ChainedCliktCommand]:           api/clikt-mordant/com.github.ajalt.clikt.command/-chained-clikt-command/index.html
+[CliktCommand]:                  api/clikt-mordant/com.github.ajalt.clikt.core/-clikt-command/index.html
 [Context.findOrSetObject]:       api/clikt/com.github.ajalt.clikt.core/find-or-set-object.html
-[Context.obj]:                   api/clikt/com.github.ajalt.clikt.core/-context/obj.html
+[Context.obj]:                   api/clikt/com.github.ajalt.clikt.core/obj.html
 [Context]:                       api/clikt/com.github.ajalt.clikt.core/-context/index.html
 [context]:                       api/clikt/com.github.ajalt.clikt.core/context.html
 [customizing-context]:           #customizing-contexts
@@ -532,5 +531,5 @@ applies a series of transformations to it, printing the final result:
 [issueMessage]:                  api/clikt/com.github.ajalt.clikt.core/-base-clikt-command/issue-message.html
 [printing-to-stdout-and-stderr]: quickstart.md#printing-to-stdout-and-stderr
 [requireObject]:                 api/clikt/com.github.ajalt.clikt.core/require-object.html
-[run]:                           api/clikt/com.github.ajalt.clikt.core/-clikt-command/run.html
+[run]:                           api/clikt/com.github.ajalt.clikt.core/-runnable-clikt-command/run.html
 [subcommands]:                   api/clikt/com.github.ajalt.clikt.core/subcommands.html
diff --git a/docs/options.md b/docs/options.md
@@ -1227,7 +1227,7 @@ val opt: Pair<Int, Int> by option("-o", "--opt")
 [associate]:                   api/clikt/com.github.ajalt.clikt.parameters.options/associate.html
 [choice-options]:              #choice-options
 [choice]:                      api/clikt/com.github.ajalt.clikt.parameters.types/choice.html
-[CliktCommand.init]:           api/clikt/com.github.ajalt.clikt.core/-clikt-command/-clikt-command.html
+[CliktCommand.init]:           api/clikt-mordant/com.github.ajalt.clikt.core/-clikt-command/-clikt-command.html
 [CliktCommand.main]:           api/clikt/com.github.ajalt.clikt.core/main.html
 [CliktCommand.registerOption]: api/clikt/com.github.ajalt.clikt.core/-base-clikt-command/register-option.html
 [co-occurring-option-groups]:  #co-occurring-option-groups
@@ -1262,7 +1262,7 @@ val opt: Pair<Int, Int> by option("-o", "--opt")
 [pair]:                        api/clikt/com.github.ajalt.clikt.parameters.options/pair.html
 [parameter-types]:             parameters.md#parameter-types
 [PrintMessage]:                api/clikt/com.github.ajalt.clikt.core/-print-message/index.html
-[prompt]:                      api/clikt/com.github.ajalt.clikt.parameters.options/prompt.html
+[prompt]:                      api/clikt-mordant/com.github.ajalt.clikt.parameters.options/prompt.html
 [PropertiesValueSource]:       api/clikt/com.github.ajalt.clikt.sources/-properties-value-source/index.html
 [readEnvvarFirst]:             api/clikt/com.github.ajalt.clikt.core/-context/-builder/read-envvar-before-value-source.html
 [required]:                    api/clikt/com.github.ajalt.clikt.parameters.groups/required.html

diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -181,15 +181,15 @@ distribution scripts in your build folder, which you can then execute normally.
 [runsample][runsample] script for an example of this approach.
 
 
-[application_plugin]: https://docs.gradle.org/current/userguide/application_plugin.html
-[argument]:           api/clikt/com.github.ajalt.clikt.parameters.arguments/argument.html
-[clikt-samples]:      https://github.com/ajalt/clikt/tree/master/samples
-[CliktCommand]:       api/clikt/com.github.ajalt.clikt.core/-clikt-command/index.html
-[echo]:               api/clikt/com.github.ajalt.clikt.core/-base-clikt-command/echo.html
-[main]:               api/clikt/com.github.ajalt.clikt.core/main.html
-[option]:             api/clikt/com.github.ajalt.clikt.parameters.options/option.html
-[println]:            https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io/println.html
-[README]:             https://github.com/ajalt/clikt
-[runsample]:          https://github.com/ajalt/clikt/blob/master/runsample
-[SuspendingCliktCommand]: api/clikt/com.github.ajalt.clikt.command/-suspending-clikt-command/index.html
-[test]:               testing.md
+[application_plugin]:       https://docs.gradle.org/current/userguide/application_plugin.html
+[argument]:                 api/clikt/com.github.ajalt.clikt.parameters.arguments/argument.html
+[clikt-samples]:            https://github.com/ajalt/clikt/tree/master/samples
+[CliktCommand]:             api/clikt-mordant/com.github.ajalt.clikt.core/-clikt-command/index.html
+[echo]:                     api/clikt/com.github.ajalt.clikt.core/-base-clikt-command/echo.html
+[main]:                     api/clikt/com.github.ajalt.clikt.core/main.html
+[option]:                   api/clikt/com.github.ajalt.clikt.parameters.options/option.html
+[println]:                  https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io/println.html
+[README]:                   https://github.com/ajalt/clikt
+[runsample]:                https://github.com/ajalt/clikt/blob/master/runsample
+[SuspendingCliktCommand]:   api/clikt-mordant/com.github.ajalt.clikt.command/-suspending-clikt-command/index.html
+[test]:                     testing.md
diff --git a/docs/testing.md b/docs/testing.md
@@ -107,5 +107,5 @@ To capture output, [override the command's console][replacing-stdin].
 [parse]:               api/clikt/com.github.ajalt.clikt.core/parse.html
 [prompt]:              options.md#prompting-for-input
 [replacing-stdin]:     advanced.md#replacing-stdin-and-stdout
-[test-result]:         api/clikt/com.github.ajalt.clikt.testing/-clikt-command-test-result/index.html
-[test]:                api/clikt/com.github.ajalt.clikt.testing/test.html
+[test-result]:         api/clikt-mordant/com.github.ajalt.clikt.testing/-clikt-command-test-result/index.html
+[test]:                api/clikt-mordant/com.github.ajalt.clikt.testing/test.html
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -55,6 +55,11 @@ markdown_extensions:
   - tables
   - admonition
 
+validation:
+  nav:
+    # nav links like `foo/#anchor` work, but are incorrectly flagged as broken
+    not_found: ignore
+
 nav:
   - 'Quickstart':
       - 'Basic Concepts': quickstart.md
@@ -133,7 +138,7 @@ nav:
       - 'Custom run behavior': advanced/#custom-run-behavior
       - 'Multiplatform Support': advanced/#multiplatform-support
   - 'Testing':
-      - 'Testing Your Commands': testing/
+      - 'Testing Your Commands': testing.md
       - 'Testing Environment Variables': testing/#testing-environment-variables
       - 'Custom Testing': testing/#custom-testing
   - 'Utilities':
@@ -155,6 +160,7 @@ nav:
       - 'Arguments': api/clikt/com.github.ajalt.clikt.parameters.arguments/
       - 'Parameter Type Conversions': api/clikt/com.github.ajalt.clikt.parameters.types/
       - 'Output Formatting': api/clikt/com.github.ajalt.clikt.output/
+      - 'All Modules': api/clikt/
   - 'Releases':
     - 'Change Log': changelog.md
     - 'Upgrading to Newer Releases': migration.md