diff --git a/docs/configuration/options.md b/docs/configuration/options.md index 3617b8fa..f0b79c49 100644 --- a/docs/configuration/options.md +++ b/docs/configuration/options.md @@ -1,4 +1,6 @@ -# Settings +# Configuration + +## Settings The plugin must have a configuration, located at the top directory; it can be either: @@ -8,12 +10,11 @@ The plugin must have a configuration, located at the top directory; it can be ei In the configuration, you should at least provide the following configuration: -- `plugin_path`, the folder where the source code is located - -Side note, the plugin path shouldn't have any dash character. +- `plugin_path`, the folder where the source code is located under the git repository. See You can find a template `.qgis-plugin-ci` in this repository. -You can read the docstring of the [Parameters module](/_apidoc/qgispluginci.parameters) to know parameters which are available in the file. +You can read the docstring of the [Parameters module](/_apidoc/qgispluginci.parameters) +to know parameters which are available in the file. ## Conventions diff --git a/docs/configuration/plugin_path.md b/docs/configuration/plugin_path.md new file mode 100644 index 00000000..f03f670e --- /dev/null +++ b/docs/configuration/plugin_path.md @@ -0,0 +1,11 @@ +# Plugin source path + +The plugin path should be named in a distinctive form for the plugin +as it will be used in QGIS for the plugin folder name. +For instance, `my_super_transformer` for _My Super Transformer_ plugin. + +Also, [`use_project_slug_as_plugin_directory`](/_apidoc/qgispluginci.parameters) can be used to alter this behavior. +If the source directory is not at the top level, the [`project_slug`](/_apidoc/qgispluginci.parameters) +will automatically be used in any case. + +Side note, the plugin path shouldn't contain any dash character. diff --git a/docs/index.md b/docs/index.md index e1a8a109..a5965ac4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -29,6 +29,7 @@ caption: Configuration maxdepth: 1 --- configuration/options +configuration/plugin_path configuration/exclude configuration/submodules configuration/translation