From 6bbb464d92afba46ced18d175ce4f302e44525f1 Mon Sep 17 00:00:00 2001 From: Artur Dobrogowski Date: Tue, 21 Nov 2023 14:03:13 +0100 Subject: [PATCH] docs: added makefile and fixed disclaimer --- docs/Makefile | 20 +++++++++++++++++++ .../02_installation/02_configuration.md | 7 +++---- 2 files changed, 23 insertions(+), 4 deletions(-) create mode 100644 docs/Makefile diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/source/02_installation/02_configuration.md b/docs/source/02_installation/02_configuration.md index f6b3622..02ed058 100644 --- a/docs/source/02_installation/02_configuration.md +++ b/docs/source/02_installation/02_configuration.md @@ -181,10 +181,6 @@ def generate_config(self) -> dict: First one - `target_config_file` should return the name of the configuration file to be generated (e.g. `credentials.yml`) and the `generate_config` should return a dictionary, which will be then serialized into the target file as YAML. If the target file already exists during the invocation, it will be merged (see method `kedro_vertexai.dynamic_config.DynamicConfigProvider.merge_with_existing` ) with the existing one and then saved again. Note that the `generate_config` has access to an initialized plugin config via `self.config` property, so any values from the `vertexai.yml` configuration is accessible. -````note -Make sure that all nodes in pipeline have names and their names are unique within the pipeline when using this feature. -```` - ## Grouping feature @@ -213,6 +209,9 @@ This grouping class is used during pipeline translation at plugin pipeline gener - `dependencies` - which defines child-parent relation of all groups in `node_mapping`. `Grouping` class also validates dependencies upon creation to check whether the grouping is valid. That means it does not introduce a cycle in dependencies graph. +````{note} +Make sure that all nodes in pipeline have names and their names are unique within the pipeline when using this feature. +```` ## Resources configuration