Skip to content

Commit

Permalink
Remove excess whitespaces from markdown docs (#348)
Browse files Browse the repository at this point in the history
  • Loading branch information
priitlatt authored Sep 15, 2023
1 parent b9573d5 commit 07fdf70
Show file tree
Hide file tree
Showing 26 changed files with 36 additions and 34 deletions.
2 changes: 2 additions & 0 deletions doc.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import os
import re
import sys
import textwrap
from collections import defaultdict
from functools import reduce
from pathlib import Path
Expand Down Expand Up @@ -442,6 +443,7 @@ def _process_description(argument: SerializedArgument) -> str:


def str_plain(string: str) -> str:
string = textwrap.dedent(string)
bold = re.escape(cli.Colors.BOLD.value)
blue = re.escape(cli.Colors.BRIGHT_BLUE.value)
reset = re.escape(cli.Colors.RESET.value)
Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ CLI tools

|Tool name|Description|
| :--- | :--- |
|[`android-app-bundle`](android-app-bundle/README.md)|Manage Android App Bundles using [Bundletool](https://developer.android.com/studio/command-line/bundletool)|
|[`android-app-bundle`](android-app-bundle/README.md)|Manage Android App Bundles using [Bundletool](https://developer.android.com/studio/command-line/bundletool)|
|[`android-keystore`](android-keystore/README.md)|Manage your Android app code signing keystores|
|[`app-store-connect`](app-store-connect/README.md)|Interact with Apple services via App Store Connect API|
|[`codemagic-cli-tools`](codemagic-cli-tools/README.md)|Show general information of installed Codemagic CLI tools|
|[`firebase-app-distribution`](firebase-app-distribution/README.md)|Utility to list releases and retrieve the latest release build version number from Firebase|
|[`git-changelog`](git-changelog/README.md)|Generate a changelog text from git history|
|[`google-play`](google-play/README.md)|Utility to get the latest build numbers from Google Play using Google Play Developer API|
|[`keychain`](keychain/README.md)|Utility to manage macOS keychains and certificates|
|[`universal-apk`](universal-apk/README.md)|Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle` instead|
|[`xcode-project`](xcode-project/README.md)|Utility to work with Xcode projects. Use it to manage iOS application code signing properties for builds, create IPAs and run tests|
|[`universal-apk`](universal-apk/README.md)|Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle` instead|
|[`xcode-project`](xcode-project/README.md)|Utility to work with Xcode projects. Use it to manage iOS application code signing properties for builds, create IPAs and run tests|
4 changes: 2 additions & 2 deletions docs/android-app-bundle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ android-app-bundle
==================


**Manage Android App Bundles using [Bundletool](https://developer.android.com/studio/command-line/bundletool)**
**Manage Android App Bundles using [Bundletool](https://developer.android.com/studio/command-line/bundletool)**
### Usage
```bash
android-app-bundle [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v]
Expand Down Expand Up @@ -39,7 +39,7 @@ Enable verbose logging for commands

|Action|Description|
| :--- | :--- |
|[`build-apks`](build-apks.md)|Generates an APK Set archive containing either all possible split APKs and standalone APKs or APKs optimized for the connected device (see connected- device flag). Returns list of generated APK set archives|
|[`build-apks`](build-apks.md)|Generates an APK Set archive containing either all possible split APKs and standalone APKs or APKs optimized for the connected device (see connected- device flag). Returns list of generated APK set archives|
|[`build-universal-apk`](build-universal-apk.md)|Shortcut for `build-apks` to build universal APKs from bundles|
|[`bundletool-version`](bundletool-version.md)|Get Bundletool version|
|[`dump`](dump.md)|Get files list or extract values from the bundle in a human-readable form|
Expand Down
2 changes: 1 addition & 1 deletion docs/android-app-bundle/build-apks.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ build-apks
==========


**Generates an APK Set archive containing either all possible split APKs and standalone APKs or APKs optimized for the connected device (see connected- device flag). Returns list of generated APK set archives**
**Generates an APK Set archive containing either all possible split APKs and standalone APKs or APKs optimized for the connected device (see connected- device flag). Returns list of generated APK set archives**
### Usage
```bash
android-app-bundle build-apks [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v]
Expand Down
2 changes: 1 addition & 1 deletion docs/android-keystore/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ Enable verbose logging for commands
|[`create-debug-keystore`](create-debug-keystore.md)|Create Android debug keystore at ~/.android/debug.keystore|
|[`certificate`](certificate.md)|Extract certificate for specified alias from the keystore|
|[`certificates`](certificates.md)|List certificates that are included in keystore|
|[`verify`](verify.md)|Check that the keystore password, key password and key alias are correct for specified keystore|
|[`verify`](verify.md)|Check that the keystore password, key password and key alias are correct for specified keystore|
2 changes: 1 addition & 1 deletion docs/android-keystore/verify.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ verify
======


**Check that the keystore password, key password and key alias are correct for specified keystore**
**Check that the keystore password, key password and key alias are correct for specified keystore**
### Usage
```bash
android-keystore verify [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v]
Expand Down
2 changes: 1 addition & 1 deletion docs/app-store-connect/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Enable verbose logging for commands
|[`delete-bundle-id`](delete-bundle-id.md)|Delete specified Bundle ID from Apple Developer portal|
|[`delete-certificate`](delete-certificate.md)|Delete specified Signing Certificate from Apple Developer portal|
|[`delete-profile`](delete-profile.md)|Delete specified Profile from Apple Developer portal|
|[`fetch-signing-files`](fetch-signing-files.md)|Fetch provisioning profiles and code signing certificates for Bundle ID with given identifier|
|[`fetch-signing-files`](fetch-signing-files.md)|Fetch provisioning profiles and code signing certificates for Bundle ID with given identifier|
|[`get-bundle-id`](get-bundle-id.md)|Get specified Bundle ID from Apple Developer portal|
|[`get-certificate`](get-certificate.md)|Get specified Signing Certificate from Apple Developer portal|
|[`get-latest-app-store-build-number`](get-latest-app-store-build-number.md)|Get the latest App Store build number of the highest version for the given application|
Expand Down
8 changes: 4 additions & 4 deletions docs/app-store-connect/app-store-version-localizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Enable verbose logging for commands

|Action|Description|
| :--- | :--- |
|[`create`](app-store-version-localizations/create.md)|Create an App Store Version Localization. Add localized version-level information for a new locale.|
|[`delete`](app-store-version-localizations/delete.md)|Delete an App Store Version Localization. Remove a language from your version metadata.|
|[`get`](app-store-version-localizations/get.md)|Read App Store Version Localization Information. Get localized version-level information.|
|[`modify`](app-store-version-localizations/modify.md)|Modify an App Store Version Localization. Edit localized version-level information for a particular language.|
|[`create`](app-store-version-localizations/create.md)|Create an App Store Version Localization. Add localized version-level information for a new locale.|
|[`delete`](app-store-version-localizations/delete.md)|Delete an App Store Version Localization. Remove a language from your version metadata.|
|[`get`](app-store-version-localizations/get.md)|Read App Store Version Localization Information. Get localized version-level information.|
|[`modify`](app-store-version-localizations/modify.md)|Modify an App Store Version Localization. Edit localized version-level information for a particular language.|
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ create
======


**Create an App Store Version Localization. Add localized version-level information for a new locale.**
**Create an App Store Version Localization. Add localized version-level information for a new locale.**
### Usage
```bash
app-store-connect app-store-version-localizations create [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ delete
======


**Delete an App Store Version Localization. Remove a language from your version metadata.**
**Delete an App Store Version Localization. Remove a language from your version metadata.**
### Usage
```bash
app-store-connect app-store-version-localizations delete [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ get
===


**Read App Store Version Localization Information. Get localized version-level information.**
**Read App Store Version Localization Information. Get localized version-level information.**
### Usage
```bash
app-store-connect app-store-version-localizations get [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ modify
======


**Modify an App Store Version Localization. Edit localized version-level information for a particular language.**
**Modify an App Store Version Localization. Edit localized version-level information for a particular language.**
### Usage
```bash
app-store-connect app-store-version-localizations modify [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v]
Expand Down
2 changes: 1 addition & 1 deletion docs/app-store-connect/app-store-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,5 +93,5 @@ Enable verbose logging for commands
| :--- | :--- |
|[`create`](app-store-versions/create.md)|Add a new App Store version to an app using specified build.|
|[`delete`](app-store-versions/delete.md)|Delete specified App Store version from Apple Developer portal|
|[`localizations`](app-store-versions/localizations.md)|List All App Store Version Localizations for an App Store Version. Get a list of localized, version-level information about an app, for all locales.|
|[`localizations`](app-store-versions/localizations.md)|List All App Store Version Localizations for an App Store Version. Get a list of localized, version-level information about an app, for all locales.|
|[`modify`](app-store-versions/modify.md)|Update the app store version for a specific app.|
2 changes: 1 addition & 1 deletion docs/app-store-connect/app-store-versions/localizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ localizations
=============


**List All App Store Version Localizations for an App Store Version. Get a list of localized, version-level information about an app, for all locales.**
**List All App Store Version Localizations for an App Store Version. Get a list of localized, version-level information about an app, for all locales.**
### Usage
```bash
app-store-connect app-store-versions localizations [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v]
Expand Down
2 changes: 1 addition & 1 deletion docs/app-store-connect/beta-build-localizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Enable verbose logging for commands

|Action|Description|
| :--- | :--- |
|[`create`](beta-build-localizations/create.md)|Create a beta build localization if it doesn't exist or update existing beta build localization for specified locale|
|[`create`](beta-build-localizations/create.md)|Create a beta build localization if it doesn't exist or update existing beta build localization for specified locale|
|[`delete`](beta-build-localizations/delete.md)|Delete a beta build localization|
|[`get`](beta-build-localizations/get.md)|Get beta build localization|
|[`list`](beta-build-localizations/list.md)|List beta build localizations|
Expand Down
2 changes: 1 addition & 1 deletion docs/app-store-connect/beta-build-localizations/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ create
======


**Create a beta build localization if it doesn't exist or update existing beta build localization for specified locale**
**Create a beta build localization if it doesn't exist or update existing beta build localization for specified locale**
### Usage
```bash
app-store-connect beta-build-localizations create [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v]
Expand Down
2 changes: 1 addition & 1 deletion docs/app-store-connect/fetch-signing-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ fetch-signing-files
===================


**Fetch provisioning profiles and code signing certificates for Bundle ID with given identifier**
**Fetch provisioning profiles and code signing certificates for Bundle ID with given identifier**
### Usage
```bash
app-store-connect fetch-signing-files [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v]
Expand Down
2 changes: 1 addition & 1 deletion docs/google-play/tracks.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ Enable verbose logging for commands
| :--- | :--- |
|[`get`](tracks/get.md)|Get information about specified track from Google Play Developer API|
|[`list`](tracks/list.md)|Get information about specified track from Google Play Developer API|
|[`promote-release`](tracks/promote-release.md)|Promote releases from source track to target track. If filters for source track release are not specified, then the latest release will be promoted|
|[`promote-release`](tracks/promote-release.md)|Promote releases from source track to target track. If filters for source track release are not specified, then the latest release will be promoted|
2 changes: 1 addition & 1 deletion docs/google-play/tracks/promote-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ promote-release
===============


**Promote releases from source track to target track. If filters for source track release are not specified, then the latest release will be promoted**
**Promote releases from source track to target track. If filters for source track release are not specified, then the latest release will be promoted**
### Usage
```bash
google-play tracks promote-release [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v]
Expand Down
4 changes: 2 additions & 2 deletions docs/keychain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ Enable verbose logging for commands
|[`create`](create.md)|Create a macOS keychain, add it to the search list|
|[`delete`](delete.md)|Delete keychains and remove them from the search list|
|[`get-default`](get-default.md)|Show the system default keychain|
|[`initialize`](initialize.md)|Set up the keychain to be used for code signing. Create the keychain at specified path with specified password with given timeout. Make it default and unlock it for upcoming use|
|[`initialize`](initialize.md)|Set up the keychain to be used for code signing. Create the keychain at specified path with specified password with given timeout. Make it default and unlock it for upcoming use|
|[`list-certificates`](list-certificates.md)|List available code signing certificates in specified keychain|
|[`lock`](lock.md)|Lock the specified keychain|
|[`make-default`](make-default.md)|Set the keychain as the system default keychain|
|[`set-timeout`](set-timeout.md)|Set timeout settings for the keychain. If seconds are not provided, then no-timeout will be set|
|[`set-timeout`](set-timeout.md)|Set timeout settings for the keychain. If seconds are not provided, then no-timeout will be set|
|[`show-info`](show-info.md)|Show all settings for the keychain|
|[`unlock`](unlock.md)|Unlock the specified keychain|
|[`use-login`](use-login.md)|Use login keychain as the default keychain|
2 changes: 1 addition & 1 deletion docs/keychain/initialize.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ initialize
==========


**Set up the keychain to be used for code signing. Create the keychain at specified path with specified password with given timeout. Make it default and unlock it for upcoming use**
**Set up the keychain to be used for code signing. Create the keychain at specified path with specified password with given timeout. Make it default and unlock it for upcoming use**
### Usage
```bash
keychain initialize [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v]
Expand Down
2 changes: 1 addition & 1 deletion docs/keychain/set-timeout.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ set-timeout
===========


**Set timeout settings for the keychain. If seconds are not provided, then no-timeout will be set**
**Set timeout settings for the keychain. If seconds are not provided, then no-timeout will be set**
### Usage
```bash
keychain set-timeout [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v]
Expand Down
4 changes: 2 additions & 2 deletions docs/universal-apk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ universal-apk
=============


**Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle` instead**
**Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle` instead**
### Usage
```bash
universal-apk [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v]
Expand Down Expand Up @@ -66,4 +66,4 @@ Enable verbose logging for commands

|Action|Description|
| :--- | :--- |
|[`generate`](generate.md)|Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle build-universal-apk` instead|
|[`generate`](generate.md)|Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle build-universal-apk` instead|
2 changes: 1 addition & 1 deletion docs/universal-apk/generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ generate
========


**Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle build-universal-apk` instead**
**Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle build-universal-apk` instead**
### Usage
```bash
universal-apk generate [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v]
Expand Down
4 changes: 2 additions & 2 deletions docs/xcode-project/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ xcode-project
=============


**Utility to work with Xcode projects. Use it to manage iOS application code signing properties for builds, create IPAs and run tests**
**Utility to work with Xcode projects. Use it to manage iOS application code signing properties for builds, create IPAs and run tests**
### Usage
```bash
xcode-project [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v]
Expand Down Expand Up @@ -50,4 +50,4 @@ Enable verbose logging for commands
|[`run-tests`](run-tests.md)|Run unit or UI tests for given Xcode project or workspace|
|[`show-build-settings`](show-build-settings.md)|Show build settings for Xcode project|
|[`test-summary`](test-summary.md)|Show summary of Xcode Test Result|
|[`use-profiles`](use-profiles.md)|Set up code signing settings on specified Xcode projects to use given provisioning profiles|
|[`use-profiles`](use-profiles.md)|Set up code signing settings on specified Xcode projects to use given provisioning profiles|
2 changes: 1 addition & 1 deletion docs/xcode-project/use-profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use-profiles
============


**Set up code signing settings on specified Xcode projects to use given provisioning profiles**
**Set up code signing settings on specified Xcode projects to use given provisioning profiles**
### Usage
```bash
xcode-project use-profiles [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v]
Expand Down

0 comments on commit 07fdf70

Please sign in to comment.