Merge pull request #26 from 05nelsonm/mn/documentation/mkdocs-multi-module-links

Fix Mkdocs multi module links generated by Dokka plugin

Author: 05nelsonm

build.gradle

@@ -25,6 +25,17 @@ allprojects  {
     }
 }
 
+// Dokka's configuration.externalDocumentationLink.url setting for connecting methods/variables
+// in each module is quarky, especially when relying on Mkdocs to generate a website using the
+// Markdown files that are created. the `externalDocumentationLink.url` setting requires a
+// protocol (http, https, etc.) such that we cannot just input what we want (../../../module-name)
+// and are required to go back over all files within the `docs` directory, search for our string
+// constant, and replace it with what we want after Dokka Docs are all generated.
+task fixDokkaDocLinks(type: Exec) {
+    workingDir "$rootDir"
+    commandLine "scripts/fix_dokka_doc_external_links.sh"
+}
+
 task clean(type: Delete) {
   delete rootProject.buildDir
 }

docs/documentation.md

@@ -1,8 +1,8 @@
 #API Documentation
 
-## [topl-service](./topl-service/io.matthewnelson.topl_service/index.md)
+## [topl-service](./topl-service/index.md)
 
-## [topl-core-base](./topl-core-base/io.matthewnelson.topl_core_base/index.md)
+## [topl-core-base](./topl-core-base/index.md)
 
 <!-- Hold off linking to docs until release -->
 <!-- ## [topl-core](./topl-core/io.matthewnelson.topl_core/index.md) -->

docs/releasing.md

@@ -27,6 +27,7 @@ extra:
 ```
 rm -rf docs/topl-core docs/topl-core-base docs/topl-service
 ./gradlew topl-core-base:dokka topl-core:dokka topl-service:dokka
+./gradlew fixDokkaDocLinks
 ```
 
 - Update `docs/changelog.md` after checking out all changes:
@@ -108,6 +109,7 @@ git push
         - `pipenv shell`
         - `mkdocs serve` to check locally
         - `mkdocs gh-deploy` to deploy
+        - Ensure docs are served <a href="https://topl-android.matthewnelson.io" target="_blank">Here</a>
         - `exit`
     - Go to the <a href="https://github.com/05nelsonm/TorOnionProxyLibrary-Android/releases/new" target="_blank">Draft a new release</a> page,
       enter the release name ({{ topl_android.next_release }}) as tag and title, and have the description

docs/topl-core/io.matthewnelson.topl_core.broadcaster/-broadcast-logger/event-broadcaster.md

@@ -2,7 +2,7 @@
 
 # eventBroadcaster
 
-`val eventBroadcaster: `[`EventBroadcaster`](file:/home/matthew/AndroidStudioProjects/personal_projects/TorOnionProxyLibrary-Android/docs/topl-core-base/io.matthewnelson.topl_core_base/-event-broadcaster/index.md) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core/src/main/java/io/matthewnelson/topl_core/broadcaster/BroadcastLogger.kt#L50)
+`val eventBroadcaster: `[`EventBroadcaster`](../../../topl-core-base/io.matthewnelson.topl_core_base/-event-broadcaster/index.md) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core/src/main/java/io/matthewnelson/topl_core/broadcaster/BroadcastLogger.kt#L50)
 
 For broadcasting the info
 

docs/topl-core/io.matthewnelson.topl_core.broadcaster/-broadcast-logger/index.md

@@ -10,8 +10,8 @@ should **never** make it to a release build.
 
 To enable Logcat messages, [buildConfigDebug](#) must be `true` (w/e you have sent
 [io.matthewnelson.topl_core.OnionProxyManager](../../io.matthewnelson.topl_core/-onion-proxy-manager/index.md) upon instantiation), and
-[TorSettings.hasDebugLogs](file:/home/matthew/AndroidStudioProjects/personal_projects/TorOnionProxyLibrary-Android/docs/topl-core-base/io.matthewnelson.topl_core_base/-tor-settings/has-debug-logs.md) must also be `true`. This way if your implementation of the
-Library is causing problems in your App you need only set [TorSettings.hasDebugLogs](file:/home/matthew/AndroidStudioProjects/personal_projects/TorOnionProxyLibrary-Android/docs/topl-core-base/io.matthewnelson.topl_core_base/-tor-settings/has-debug-logs.md) to
+[TorSettings.hasDebugLogs](../../../topl-core-base/io.matthewnelson.topl_core_base/-tor-settings/has-debug-logs.md) must also be `true`. This way if your implementation of the
+Library is causing problems in your App you need only set [TorSettings.hasDebugLogs](../../../topl-core-base/io.matthewnelson.topl_core_base/-tor-settings/has-debug-logs.md) to
 `true` for a Debug build of your App.
 
 See helper method [io.matthewnelson.topl_core.OnionProxyManager.getBroadcastLogger](../../io.matthewnelson.topl_core/-onion-proxy-manager/get-broadcast-logger.md) to
@@ -31,7 +31,7 @@ instantiate.
 
 | Name | Summary |
 |---|---|
-| [eventBroadcaster](event-broadcaster.md) | For broadcasting the info`val eventBroadcaster: `[`EventBroadcaster`](file:/home/matthew/AndroidStudioProjects/personal_projects/TorOnionProxyLibrary-Android/docs/topl-core-base/io.matthewnelson.topl_core_base/-event-broadcaster/index.md) |
+| [eventBroadcaster](event-broadcaster.md) | For broadcasting the info`val eventBroadcaster: `[`EventBroadcaster`](../../../topl-core-base/io.matthewnelson.topl_core_base/-event-broadcaster/index.md) |
 | [TAG](-t-a-g.md) | Typically, the class name, but able to be set to whatever you wish`val TAG: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
 
 ### Functions

docs/topl-core/io.matthewnelson.topl_core.settings/-tor-settings-builder/control-port-write-to-file.md

@@ -2,4 +2,4 @@
 
 # controlPortWriteToFile
 
-`fun controlPortWriteToFile(torConfigFiles: `[`TorConfigFiles`](file:/home/matthew/AndroidStudioProjects/personal_projects/TorOnionProxyLibrary-Android/docs/topl-core-base/io.matthewnelson.topl_core_base/-tor-config-files/index.md)`): `[`TorSettingsBuilder`](index.md) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core/src/main/java/io/matthewnelson/topl_core/settings/TorSettingsBuilder.kt#L240)
+`fun controlPortWriteToFile(torConfigFiles: `[`TorConfigFiles`](../../../topl-core-base/io.matthewnelson.topl_core_base/-tor-config-files/index.md)`): `[`TorSettingsBuilder`](index.md) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core/src/main/java/io/matthewnelson/topl_core/settings/TorSettingsBuilder.kt#L240)

docs/topl-core/io.matthewnelson.topl_core.settings/-tor-settings-builder/finish-and-return-string.md

@@ -6,5 +6,5 @@
 
 This returns what's in the [buffer](#) as a String and then clears it.
 You still need to write the String to the
-[io.matthewnelson.topl_core_base.TorConfigFiles.torrcFile](file:/home/matthew/AndroidStudioProjects/personal_projects/TorOnionProxyLibrary-Android/docs/topl-core-base/io.matthewnelson.topl_core_base/-tor-config-files/torrc-file.md).
+[io.matthewnelson.topl_core_base.TorConfigFiles.torrcFile](../../../topl-core-base/io.matthewnelson.topl_core_base/-tor-config-files/torrc-file.md).
 

docs/topl-core/io.matthewnelson.topl_core.settings/-tor-settings-builder/index.md

@@ -15,7 +15,7 @@ file however you wish.
 
 Calling [finishAndReturnString](finish-and-return-string.md) will return to you the String that has been
 built for you to write to the
-[io.matthewnelson.topl_core_base.TorConfigFiles.torrcFile](file:/home/matthew/AndroidStudioProjects/personal_projects/TorOnionProxyLibrary-Android/docs/topl-core-base/io.matthewnelson.topl_core_base/-tor-config-files/torrc-file.md).
+[io.matthewnelson.topl_core_base.TorConfigFiles.torrcFile](../../../topl-core-base/io.matthewnelson.topl_core_base/-tor-config-files/torrc-file.md).
 
 Calling [finishAndWriteToTorrcFile](finish-and-write-to-torrc-file.md) will do just that.
 
@@ -46,7 +46,7 @@ onionProxyManager.getNewSettingsBuilder()
 | [configurePluggableTransportsFromSettings](configure-pluggable-transports-from-settings.md) | `fun configurePluggableTransportsFromSettings(pluggableTransportClient: `[`File`](https://docs.oracle.com/javase/6/docs/api/java/io/File.html)`?): `[`TorSettingsBuilder`](./index.md) |
 | [connectionPadding](connection-padding.md) | `fun connectionPadding(setting: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TorSettingsBuilder`](./index.md) |
 | [connectionPaddingFromSettings](connection-padding-from-settings.md) | `fun connectionPaddingFromSettings(): `[`TorSettingsBuilder`](./index.md) |
-| [controlPortWriteToFile](control-port-write-to-file.md) | `fun controlPortWriteToFile(torConfigFiles: `[`TorConfigFiles`](file:/home/matthew/AndroidStudioProjects/personal_projects/TorOnionProxyLibrary-Android/docs/topl-core-base/io.matthewnelson.topl_core_base/-tor-config-files/index.md)`): `[`TorSettingsBuilder`](./index.md) |
+| [controlPortWriteToFile](control-port-write-to-file.md) | `fun controlPortWriteToFile(torConfigFiles: `[`TorConfigFiles`](../../../topl-core-base/io.matthewnelson.topl_core_base/-tor-config-files/index.md)`): `[`TorSettingsBuilder`](./index.md) |
 | [controlPortWriteToFileFromConfig](control-port-write-to-file-from-config.md) | `fun controlPortWriteToFileFromConfig(): `[`TorSettingsBuilder`](./index.md) |
 | [cookieAuthentication](cookie-authentication.md) | `fun cookieAuthentication(): `[`TorSettingsBuilder`](./index.md) |
 | [cookieAuthenticationFromSettings](cookie-authentication-from-settings.md) | `fun cookieAuthenticationFromSettings(): `[`TorSettingsBuilder`](./index.md) |
@@ -61,7 +61,7 @@ onionProxyManager.getNewSettingsBuilder()
 | [entryNodes](entry-nodes.md) | `fun entryNodes(entryNodes: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?): `[`TorSettingsBuilder`](./index.md) |
 | [excludeNodes](exclude-nodes.md) | `fun excludeNodes(excludeNodes: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?): `[`TorSettingsBuilder`](./index.md) |
 | [exitNodes](exit-nodes.md) | `fun exitNodes(exitNodes: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?): `[`TorSettingsBuilder`](./index.md) |
-| [finishAndReturnString](finish-and-return-string.md) | This returns what's in the [buffer](#) as a String and then clears it. You still need to write the String to the [io.matthewnelson.topl_core_base.TorConfigFiles.torrcFile](file:/home/matthew/AndroidStudioProjects/personal_projects/TorOnionProxyLibrary-Android/docs/topl-core-base/io.matthewnelson.topl_core_base/-tor-config-files/torrc-file.md).`fun finishAndReturnString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
+| [finishAndReturnString](finish-and-return-string.md) | This returns what's in the [buffer](#) as a String and then clears it. You still need to write the String to the [io.matthewnelson.topl_core_base.TorConfigFiles.torrcFile](../../../topl-core-base/io.matthewnelson.topl_core_base/-tor-config-files/torrc-file.md).`fun finishAndReturnString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
 | [finishAndWriteToTorrcFile](finish-and-write-to-torrc-file.md) | A convenience method for after populating the [buffer](#) by calling [updateTorSettings](update-tor-settings.md). It will overwrite your current torrc file (or create a new one if it doesn't exist) with the new settings.`fun finishAndWriteToTorrcFile(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) |
 | [geoIpFile](geo-ip-file.md) | `fun geoIpFile(path: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?): `[`TorSettingsBuilder`](./index.md) |
 | [geoIpV6File](geo-ip-v6-file.md) | `fun geoIpV6File(path: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?): `[`TorSettingsBuilder`](./index.md) |
@@ -96,7 +96,7 @@ onionProxyManager.getNewSettingsBuilder()
 | [transPort](trans-port.md) | `fun transPort(transPort: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TorSettingsBuilder`](./index.md) |
 | [transPortFromSettings](trans-port-from-settings.md) | `fun transPortFromSettings(): `[`TorSettingsBuilder`](./index.md) |
 | [transportPlugin](transport-plugin.md) | `fun transportPlugin(clientPath: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TorSettingsBuilder`](./index.md) |
-| [updateTorSettings](update-tor-settings.md) | Updates the buffer for all methods annotated with [SettingsConfig](#). You still need to call [finishAndReturnString](finish-and-return-string.md) and then write the returned String to your [io.matthewnelson.topl_core_base.TorConfigFiles.torrcFile](file:/home/matthew/AndroidStudioProjects/personal_projects/TorOnionProxyLibrary-Android/docs/topl-core-base/io.matthewnelson.topl_core_base/-tor-config-files/torrc-file.md).`fun updateTorSettings(): `[`TorSettingsBuilder`](./index.md) |
+| [updateTorSettings](update-tor-settings.md) | Updates the buffer for all methods annotated with [SettingsConfig](#). You still need to call [finishAndReturnString](finish-and-return-string.md) and then write the returned String to your [io.matthewnelson.topl_core_base.TorConfigFiles.torrcFile](../../../topl-core-base/io.matthewnelson.topl_core_base/-tor-config-files/torrc-file.md).`fun updateTorSettings(): `[`TorSettingsBuilder`](./index.md) |
 | [useBridges](use-bridges.md) | `fun useBridges(useThem: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`TorSettingsBuilder`](./index.md) |
 | [useBridgesFromSettings](use-bridges-from-settings.md) | `fun useBridgesFromSettings(): `[`TorSettingsBuilder`](./index.md) |
 | [virtualAddressNetwork](virtual-address-network.md) | `fun virtualAddressNetwork(address: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?): `[`TorSettingsBuilder`](./index.md) |

docs/topl-core/io.matthewnelson.topl_core.settings/-tor-settings-builder/update-tor-settings.md

@@ -6,7 +6,7 @@
 
 Updates the buffer for all methods annotated with [SettingsConfig](#). You still need
 to call [finishAndReturnString](finish-and-return-string.md) and then write the returned String to your
-[io.matthewnelson.topl_core_base.TorConfigFiles.torrcFile](file:/home/matthew/AndroidStudioProjects/personal_projects/TorOnionProxyLibrary-Android/docs/topl-core-base/io.matthewnelson.topl_core_base/-tor-config-files/torrc-file.md).
+[io.matthewnelson.topl_core_base.TorConfigFiles.torrcFile](../../../topl-core-base/io.matthewnelson.topl_core_base/-tor-config-files/torrc-file.md).
 
 Alternatively, call [finishAndWriteToTorrcFile](finish-and-write-to-torrc-file.md), it's up to you.
 

docs/topl-core/io.matthewnelson.topl_core.util/-core-consts/index.md

@@ -2,7 +2,7 @@
 
 # CoreConsts
 
-`abstract class CoreConsts : `[`BaseConsts`](file:/home/matthew/AndroidStudioProjects/personal_projects/TorOnionProxyLibrary-Android/docs/topl-core-base/io.matthewnelson.topl_core_base/-base-consts/index.md) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core/src/main/java/io/matthewnelson/topl_core/util/CoreConsts.kt#L27)
+`abstract class CoreConsts : `[`BaseConsts`](../../../topl-core-base/io.matthewnelson.topl_core_base/-base-consts/index.md) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core/src/main/java/io/matthewnelson/topl_core/util/CoreConsts.kt#L27)
 
 ### Constructors