diff --git a/.github/workflows/tox.yaml b/.github/workflows/tox.yaml index 0c7dd8d934..668ca3f02b 100644 --- a/.github/workflows/tox.yaml +++ b/.github/workflows/tox.yaml @@ -37,7 +37,10 @@ jobs: python -m pip install 'tox<5.0' tox-gh echo "::endgroup::" echo "::group::Create virtual environments for linting processes." - tox run -m lint --notest + tox run -m lint build-docs --notest + echo "::endgroup::" + echo "::group::Build docs." + tox run -e build-docs echo "::endgroup::" echo "::group::Wait for snap to complete" snap watch --last=install diff --git a/snapcraft/commands/account.py b/snapcraft/commands/account.py index 9887a72154..7aae727b83 100644 --- a/snapcraft/commands/account.py +++ b/snapcraft/commands/account.py @@ -88,7 +88,7 @@ def fill_parser(self, parser: "argparse.ArgumentParser") -> None: action="store_true", default=False, help=( - "Deprecated option to enable candid login. " + "(deprecated) Enable candid login. " f"Set {store.constants.ENVIRONMENT_STORE_AUTH}=candid instead" ), ) @@ -179,7 +179,7 @@ def fill_parser(self, parser: "argparse.ArgumentParser") -> None: action="store_true", default=False, help=( - "Deprecated option to enable candid login. " + "(deprecated) Enable candid login. " f"Set {store.constants.ENVIRONMENT_STORE_AUTH}=candid instead" ), ) diff --git a/snapcraft/commands/legacy.py b/snapcraft/commands/legacy.py index 4c90bc3da7..5fa002cf69 100644 --- a/snapcraft/commands/legacy.py +++ b/snapcraft/commands/legacy.py @@ -98,12 +98,12 @@ class StoreLegacyPromoteCommand(LegacyBaseCommand): Prior to releasing, visual confirmation shall be required. - The format for channels is `[/][/]` where + The format for channels is ``[/][/]`` where - is used to support long-term release channels. It is implicitly set to the default. - - is mandatory and must be one of `stable`, `candidate`, - `beta` or `edge`. + - is mandatory and must be one of ``stable``, ``candidate``, + ``beta`` or ``edge``. - is optional and dynamically creates a channel with a specific expiration date. Branches are specifically designed to support short-term hot fixes. diff --git a/snapcraft/commands/lint.py b/snapcraft/commands/lint.py index 75021e038c..15fb9bb014 100644 --- a/snapcraft/commands/lint.py +++ b/snapcraft/commands/lint.py @@ -53,7 +53,7 @@ class LintCommand(BaseCommand): The snap is installed and linted inside a build environment. If an assertion file exists in the same directory as the snap file with the name - `.assert`, it will be used to install the snap in the instance. + ``.assert``, it will be used to install the snap in the instance. """ ) diff --git a/snapcraft/commands/manage.py b/snapcraft/commands/manage.py index baf93f3cfc..3bc9c4e10c 100644 --- a/snapcraft/commands/manage.py +++ b/snapcraft/commands/manage.py @@ -39,19 +39,19 @@ class StoreReleaseCommand(BaseCommand): is a comma-separated list of valid channels in the store. The must exist in the store; to see available revisions, - run `snapcraft list-revisions `. + run ``snapcraft list-revisions ``. The channel map will be displayed after the operation takes place. To see - the status map at any other time run `snapcraft status `. + the status map at any other time run ``snapcraft status ``. - The format for a channel is `[/][/]` where + The format for a channel is ``[/][/]`` where - is used to have long-term release channels. It is implicitly - set to `latest`. If this snap requires one, it can be created by + set to ``latest``. If this snap requires one, it can be created by request by having a conversation on https://forum.snapcraft.io under the *store* category. - - is mandatory and must be one of `stable`, `candidate`, `beta` - or `edge`. + - is mandatory and must be one of ``stable``, ``candidate``, ``beta`` + or ``edge``. - is optional and dynamically creates a channel with a specific expiration date.