diff --git a/docs/source/conf.py b/docs/source/conf.py index a857f9ad18..74b070cf70 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -497,8 +497,14 @@ def _add_jinja_filters(app): app.builder.templates.environment.filters["env_override"] = env_override +def _override_permalinks_icon(app): + # https://github.com/readthedocs/sphinx_rtd_theme/issues/98#issuecomment-1503211439 + app.config.html_permalinks_icon = "ΒΆ" + + def setup(app): app.connect("builder-inited", _add_jinja_filters) + app.connect("builder-inited", _override_permalinks_icon) app.connect("autodoc-process-docstring", autodoc_process_docstring) app.add_css_file("css/qb1-sphinx-rtd.css") # fix a bug with table wraps in Read the Docs Sphinx theme: diff --git a/docs/source/faq/faq.md b/docs/source/faq/faq.md index 2e6d7ba9da..7847e1991a 100644 --- a/docs/source/faq/faq.md +++ b/docs/source/faq/faq.md @@ -1,8 +1,8 @@ # Frequently asked questions -## Kedro project development +## Visualisation -* [How do I write my own Kedro starter projects](../kedro_project_setup/starters.md#how-to-create-a-kedro-starter)? +* [Can I annotate a Kedro-Viz visualisation to show different data layers](../visualisation/kedro-viz_visualisation.md#visualise-layers)? ## Working with Jupyter @@ -10,6 +10,32 @@ * [How do I connect a Kedro project kernel to other Jupyter clients like JupyterLab](../notebooks_and_ipython/kedro_and_notebooks.md#ipython-jupyterlab-and-other-jupyter-clients)? +## Kedro project development + +* [How do I write my own Kedro starter projects](../kedro_project_setup/starters.md#how-to-create-a-kedro-starter)? + +## Configuration + +* [How do I change the setting for a configuration source folder](../configuration/configuration_basics.md#how-to-change-the-setting-for-a-configuration-source-folder)? +* [How do I change the configuration source folder at run time](../configuration/configuration_basics.md#how-to-change-the-configuration-source-folder-at-runtime)? +* [How do I specify parameters at run time](../configuration/parameters.md#how-to-specify-parameters-at-runtime)? +* [How do I read configuration from a compressed file](../configuration/configuration_basics.md#how-to-read-configuration-from-a-compressed-file)? +* [How do I access configuration in code](../configuration/configuration_basics.md#how-to-access-configuration-in-code)? +* [How do I load credentials in code](../configuration/credentials.md#how-to-load-credentials-in-code)? +* [How do I load parameters in code](../configuration/parameters.md#how-to-load-parameters-in-code)? +* [How do I specify additional configuration environments](../configuration/configuration_basics.md#how-to-specify-additional-configuration-environments)? +* [How do I change the default overriding configuration environment](../configuration/configuration_basics.md#how-to-change-the-default-overriding-environment)? +* [How do I use only one configuration environment](../configuration/configuration_basics.md#how-to-use-only-one-configuration-environment)? + +### Advanced topics + +* [How do I change which configuration files are loaded](../configuration/advanced_configuration.md#how-to-change-which-configuration-files-are-loaded)? +* [How do I ensure non default configuration files get loaded](../configuration/advanced_configuration.md#how-to-ensure-non-default-configuration-files-get-loaded)? +* [How do I bypass the configuration loading rules](../configuration/advanced_configuration.md#how-to-bypass-the-configuration-loading-rules)? +* [How do I use Jinja2 syntax in configuration](../configuration/advanced_configuration.md#how-to-use-jinja2-syntax-in-configuration)? +* [How do I do templating with the `OmegaConfigLoader`](../configuration/advanced_configuration.md#how-to-do-templating-with-the-omegaconfigloader)? +* [How do I use custom resolvers in the `OmegaConfigLoader`](../configuration/advanced_configuration.md#how-to-use-custom-resolvers-in-the-omegaconfigloader)? +* [How do I load credentials through environment variables](../configuration/advanced_configuration.md#how-to-load-credentials-through-environment-variables)? ## Datasets and the Data Catalog @@ -20,7 +46,3 @@ * [How do I create a modular pipeline](../nodes_and_pipelines/modular_pipelines.md#how-do-i-create-a-modular-pipeline)? * [Can I use generator functions in a node](../nodes_and_pipelines/nodes.md#how-to-use-generator-functions-in-a-node)? - -## Visualisation - -* [Can I annotate a Kedro-Viz visualisation to show different data layers](../visualisation/kedro-viz_visualisation.md#visualise-layers)?