From 279e62f840bee1ca8afa31b7d4c59353224417ec Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Thu, 20 Feb 2025 10:10:25 +0100 Subject: [PATCH 01/15] requirements.txt: Upgrade mkdocs https://www.mkdocs.org/about/release-notes/ --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 1acf6e21d0..f3f5733da8 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -mkdocs==1.5.1 +mkdocs==1.6.1 Pygments==2.15.0 pymdown-extensions==10.0.1 Markdown==3.2.1 From f8f28fd5f218e042dabe216e1dbcb12395a99cc9 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Thu, 20 Feb 2025 10:23:55 +0100 Subject: [PATCH 02/15] requirements.txt: Upgrade Markdown ERROR: Cannot install Markdown==3.2.1 and mkdocs==1.6.1 because these package versions have conflicting dependencies. The conflict is caused by: The user requested Markdown==3.2.1 mkdocs 1.6.1 depends on markdown>=3.3.6 --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index f3f5733da8..6a4ffe5f1c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,7 +1,7 @@ mkdocs==1.6.1 Pygments==2.15.0 pymdown-extensions==10.0.1 -Markdown==3.2.1 +Markdown==3.3.6 mkdocs-material==9.1.1 mkdocs-macros-plugin==0.7.0 mkdocs-redirects==1.2.0 From 7f4108a9dfb77db7e78b80b398760dc95bef3730 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Tue, 25 Feb 2025 15:55:19 +0100 Subject: [PATCH 03/15] IBX-9609: Upgrade all requirements (#2630) * requirements.txt: Upgrade Markdown to latest * requirements.txt: Upgrade Pygments to latest * requirements.txt: Upgrade PyMdown Extensions to latest * requirements.txt: Upgrade Material for MkDocs to latest * requirements.txt: Upgrade Mkdocs-Macros to latest * requirements.txt: Upgrade mkdocs-redirects to latest * requirements.txt: Upgrade MkDocs Autolinks Plugin to latest * navigation.css: Fix right ToC (probably due to Material for MkDocs upgrade) * navigation.css: Fix left ToC (probably due to Material for MkDocs upgrade) --- docs/css/navigation.css | 13 +++++++++++-- requirements.txt | 14 +++++++------- 2 files changed, 18 insertions(+), 9 deletions(-) diff --git a/docs/css/navigation.css b/docs/css/navigation.css index 4bac94e3dc..a079aa2634 100644 --- a/docs/css/navigation.css +++ b/docs/css/navigation.css @@ -56,6 +56,7 @@ .md-nav--secondary { padding-left: 10px; padding-bottom: 10px; + margin-bottom: 0; padding-top: 7rem; height: calc(100vh - 138px); } @@ -64,9 +65,12 @@ position: relative; } -.md-nav--secondary>ul { +.md-nav--secondary > ul { border-left: 1px solid var(--mid-grey); margin-left: 0.4rem; +} + +[dir=ltr] .md-nav--secondary ul.md-nav__list { padding-left: 0; } @@ -118,7 +122,12 @@ /* End Page TOC */ /* Main nav */ -.md-nav--primary .md-nav__link { +[dir=ltr] .md-nav--primary .md-nav__list { + padding-left: 0; +} + +[dir=ltr] .md-nav--primary .md-nav__item > .md-nav__link { + margin-right: 0; font-size: 16px; } diff --git a/requirements.txt b/requirements.txt index 6a4ffe5f1c..feef29229e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,9 +1,9 @@ mkdocs==1.6.1 -Pygments==2.15.0 -pymdown-extensions==10.0.1 -Markdown==3.3.6 -mkdocs-material==9.1.1 -mkdocs-macros-plugin==0.7.0 -mkdocs-redirects==1.2.0 -mkdocs-autolinks-plugin==0.7.0 +Pygments==2.19.1 +pymdown-extensions==10.14.3 +Markdown==3.7 +mkdocs-material==9.6.5 +mkdocs-macros-plugin==1.3.7 +mkdocs-redirects==1.2.2 +mkdocs-autolinks-plugin==0.7.1 Jinja2==3.1.5 From 2fe68f62fd6ccef5fcefa6d443022c3d701104b2 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Wed, 5 Mar 2025 15:44:58 +0100 Subject: [PATCH 04/15] .readthedocs.yml: Upgrade python & pip (#2653) --- .readthedocs.yml | 3 +-- pip_require.txt | 1 - 2 files changed, 1 insertion(+), 3 deletions(-) delete mode 100644 pip_require.txt diff --git a/.readthedocs.yml b/.readthedocs.yml index d161ec9b53..3546358553 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -7,9 +7,8 @@ mkdocs: build: os: ubuntu-20.04 tools: - python: "3.11" + python: "3.13" python: install: - - requirements: pip_require.txt - requirements: requirements.txt diff --git a/pip_require.txt b/pip_require.txt deleted file mode 100644 index 2de5dd1f5b..0000000000 --- a/pip_require.txt +++ /dev/null @@ -1 +0,0 @@ -pip==23.3 From 374ff9369e72d3b0ea3a10eaec967d24839d5904 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Fri, 7 Mar 2025 15:29:13 +0100 Subject: [PATCH 05/15] Test `absolute_links: relative_to_docs` --- docs/ai_actions/extend_ai_actions.md | 2 ++ mkdocs.yml | 3 +++ 2 files changed, 5 insertions(+) diff --git a/docs/ai_actions/extend_ai_actions.md b/docs/ai_actions/extend_ai_actions.md index 98ea873c9c..22106bbf20 100644 --- a/docs/ai_actions/extend_ai_actions.md +++ b/docs/ai_actions/extend_ai_actions.md @@ -13,6 +13,8 @@ For example, you can create a handler that connects to a translation model and u You can execute AI Actions by using the [ActionServiceInterface](../api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorAi-ActionServiceInterface.html) service, as in the following example: +You can execute AI Actions by using the [ActionServiceInterface](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorAi-ActionServiceInterface.html) service, as in the following example: + ``` php [[= include_file('code_samples/ai_actions/src/Command/AddMissingAltTextCommand.php', 102, 121) =]] ``` diff --git a/mkdocs.yml b/mkdocs.yml index a2ecde136c..2af6fbe9e8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,6 +4,9 @@ site_name: Developer Documentation repo_url: https://github.com/ibexa/documentation-developer site_url: https://doc.ibexa.co/en/latest/ copyright: "Copyright 1999-2024 Ibexa AS and others" +validation: + links: + absolute_links: relative_to_docs nav: - Ibexa Developer Documentation: index.md - Ibexa DXP editions: From 1bbfb6926421c898b641c6f102714c64f71a023d Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Fri, 7 Mar 2025 17:32:59 +0100 Subject: [PATCH 06/15] Revert "Test `absolute_links: relative_to_docs`" This reverts commit 374ff9369e72d3b0ea3a10eaec967d24839d5904. --- docs/ai_actions/extend_ai_actions.md | 2 -- mkdocs.yml | 3 --- 2 files changed, 5 deletions(-) diff --git a/docs/ai_actions/extend_ai_actions.md b/docs/ai_actions/extend_ai_actions.md index 22106bbf20..98ea873c9c 100644 --- a/docs/ai_actions/extend_ai_actions.md +++ b/docs/ai_actions/extend_ai_actions.md @@ -13,8 +13,6 @@ For example, you can create a handler that connects to a translation model and u You can execute AI Actions by using the [ActionServiceInterface](../api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorAi-ActionServiceInterface.html) service, as in the following example: -You can execute AI Actions by using the [ActionServiceInterface](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorAi-ActionServiceInterface.html) service, as in the following example: - ``` php [[= include_file('code_samples/ai_actions/src/Command/AddMissingAltTextCommand.php', 102, 121) =]] ``` diff --git a/mkdocs.yml b/mkdocs.yml index 2af6fbe9e8..a2ecde136c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,9 +4,6 @@ site_name: Developer Documentation repo_url: https://github.com/ibexa/documentation-developer site_url: https://doc.ibexa.co/en/latest/ copyright: "Copyright 1999-2024 Ibexa AS and others" -validation: - links: - absolute_links: relative_to_docs nav: - Ibexa Developer Documentation: index.md - Ibexa DXP editions: From f020b83f6134d9703f7c0259f2d9aad3bba702a4 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Fri, 7 Mar 2025 17:34:04 +0100 Subject: [PATCH 07/15] mkdocs: `absolute_links: relative_to_docs` --- mkdocs.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index a2ecde136c..2af6fbe9e8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,6 +4,9 @@ site_name: Developer Documentation repo_url: https://github.com/ibexa/documentation-developer site_url: https://doc.ibexa.co/en/latest/ copyright: "Copyright 1999-2024 Ibexa AS and others" +validation: + links: + absolute_links: relative_to_docs nav: - Ibexa Developer Documentation: index.md - Ibexa DXP editions: From ed0478897c2116ec33699f3c86417f4abeb24814 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Fri, 7 Mar 2025 18:40:41 +0100 Subject: [PATCH 08/15] mkdocs: increase unrecognized_links strictness Recommended in https://www.mkdocs.org/user-guide/configuration/#validation --- docs/api/php_api/php_api.md | 2 +- mkdocs.yml | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/api/php_api/php_api.md b/docs/api/php_api/php_api.md index e958d171fc..3cb5abd53e 100644 --- a/docs/api/php_api/php_api.md +++ b/docs/api/php_api/php_api.md @@ -5,7 +5,7 @@ page_type: reference # PHP API -The [public PHP API](../php_api_reference/) enables you to interact with [[= product_name =]]'s Repository and content model from your PHP code. +The [public PHP API](/api/php_api/php_api_reference/index.html) enables you to interact with [[= product_name =]]'s Repository and content model from your PHP code. You can use it to create, read, update, manage, and delete all objects available in [[= product_name =]], namely content and related objects such as sections, locations, content types, or languages. diff --git a/mkdocs.yml b/mkdocs.yml index 2af6fbe9e8..eb06bb9cba 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,6 +7,7 @@ copyright: "Copyright 1999-2024 Ibexa AS and others" validation: links: absolute_links: relative_to_docs + unrecognized_links: warn nav: - Ibexa Developer Documentation: index.md - Ibexa DXP editions: From c23b07aec3fcf5ba9192c97bf0aaab7e0a2ca786 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Fri, 7 Mar 2025 18:51:29 +0100 Subject: [PATCH 09/15] mkdocs: plan to increase omitted_files strictness Recommended in https://www.mkdocs.org/user-guide/configuration/#validation --- mkdocs.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index eb06bb9cba..e442b0749d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,8 +6,12 @@ site_url: https://doc.ibexa.co/en/latest/ copyright: "Copyright 1999-2024 Ibexa AS and others" validation: links: + # omitted_files: warn # TODO: Remove docs/personalization/legacy_recommendation_api.md absolute_links: relative_to_docs unrecognized_links: warn +not_in_nav: | + search_results.md + /snippets/* nav: - Ibexa Developer Documentation: index.md - Ibexa DXP editions: From e044bcfdccad2fb2a27a0144d35a4100a6a2944b Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Fri, 7 Mar 2025 19:14:37 +0100 Subject: [PATCH 10/15] mkdocs: Plan to increase anchors strictness Recommended in https://www.mkdocs.org/user-guide/configuration/#validation --- mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs.yml b/mkdocs.yml index e442b0749d..385cacb665 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,6 +9,7 @@ validation: # omitted_files: warn # TODO: Remove docs/personalization/legacy_recommendation_api.md absolute_links: relative_to_docs unrecognized_links: warn + # anchors: warn # TODO: Fix IBX-9578 not_in_nav: | search_results.md /snippets/* From e85e04068d34ea34eeaf6a93810289ac3c2b53f5 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Sun, 9 Mar 2025 10:49:20 +0100 Subject: [PATCH 11/15] IBX-9609: Upgrade mkdocs (#2627) * requirements.txt: Upgrade mkdocs to latest * requirements.txt: Upgrade Markdown to latest * requirements.txt: Upgrade Pygments to latest * requirements.txt: Upgrade PyMdown Extensions to latest * requirements.txt: Upgrade Material for MkDocs to latest * requirements.txt: Upgrade Mkdocs-Macros to latest * requirements.txt: Upgrade mkdocs-redirects to latest * requirements.txt: Upgrade MkDocs Autolinks Plugin to latest * navigation.css: Fix right ToC (probably due to Material for MkDocs upgrade) * navigation.css: Fix left ToC (probably due to Material for MkDocs upgrade) * .readthedocs.yml: Upgrade python & pip (#2653) * mkdocs: `absolute_links: relative_to_docs` (cherry picked from commit 97cf2cc93e150b96c4d73e13b717208429f57eb6) --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 385cacb665..2004d040ed 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -947,7 +947,7 @@ extra: latest_tag_4_3: '4.3.5' latest_tag_4_4: '4.4.4' latest_tag_4_5: '4.5.7' - latest_tag_4_6: '4.6.17' + latest_tag_4_6: '4.6.18' symfony_doc: 'https://symfony.com/doc/5.x' user_doc: 'https://doc.ibexa.co/projects/userguide/en/master' From 48e85a8a3f73655c3b1ebd40bb3290c2555f658a Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Sun, 9 Mar 2025 12:06:06 +0100 Subject: [PATCH 12/15] mkdocs.yml: Fix validation Fix `WARNING - Config value 'validation': Sub-option 'links': Sub-option 'omitted_files': Unrecognised configuration name: omitted_files` --- mkdocs.yml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 2004d040ed..9d5d1ab55c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,11 +5,10 @@ repo_url: https://github.com/ibexa/documentation-developer site_url: https://doc.ibexa.co/en/latest/ copyright: "Copyright 1999-2024 Ibexa AS and others" validation: - links: - # omitted_files: warn # TODO: Remove docs/personalization/legacy_recommendation_api.md - absolute_links: relative_to_docs - unrecognized_links: warn - # anchors: warn # TODO: Fix IBX-9578 + # omitted_files: warn # TODO: Remove docs/personalization/legacy_recommendation_api.md + absolute_links: relative_to_docs + unrecognized_links: warn + # anchors: warn # TODO: Fix IBX-9578 not_in_nav: | search_results.md /snippets/* From d9cdbf1315aff9828fab5b89bd5a95d3d97c3cb0 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Mon, 10 Mar 2025 09:19:27 +0100 Subject: [PATCH 13/15] Rollback docs/api/php_api/php_api.md --- docs/api/php_api/php_api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/php_api/php_api.md b/docs/api/php_api/php_api.md index 3cb5abd53e..e958d171fc 100644 --- a/docs/api/php_api/php_api.md +++ b/docs/api/php_api/php_api.md @@ -5,7 +5,7 @@ page_type: reference # PHP API -The [public PHP API](/api/php_api/php_api_reference/index.html) enables you to interact with [[= product_name =]]'s Repository and content model from your PHP code. +The [public PHP API](../php_api_reference/) enables you to interact with [[= product_name =]]'s Repository and content model from your PHP code. You can use it to create, read, update, manage, and delete all objects available in [[= product_name =]], namely content and related objects such as sections, locations, content types, or languages. From 9a7a1ff309ebcd3afbb76568d5ea20a9b4c7f518 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Thu, 13 Mar 2025 13:06:13 +0100 Subject: [PATCH 14/15] mkdocs.yml: ignore legacy_recommendation_api.md --- mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs.yml b/mkdocs.yml index 9d5d1ab55c..170f596fdf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,6 +11,7 @@ validation: # anchors: warn # TODO: Fix IBX-9578 not_in_nav: | search_results.md + personalization/legacy_recommendation_api.md /snippets/* nav: - Ibexa Developer Documentation: index.md From 8c63bda950b050a82cba3142a6808b62303012cf Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Thu, 13 Mar 2025 13:27:37 +0100 Subject: [PATCH 15/15] Update mkdocs.yml --- mkdocs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 170f596fdf..b6285eb31f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,10 +5,10 @@ repo_url: https://github.com/ibexa/documentation-developer site_url: https://doc.ibexa.co/en/latest/ copyright: "Copyright 1999-2024 Ibexa AS and others" validation: - # omitted_files: warn # TODO: Remove docs/personalization/legacy_recommendation_api.md + omitted_files: warn absolute_links: relative_to_docs unrecognized_links: warn - # anchors: warn # TODO: Fix IBX-9578 + anchors: warn # TODO: Fix IBX-9578 not_in_nav: | search_results.md personalization/legacy_recommendation_api.md