From 21a66bf112f34b25a25f7e3f5abeae038087c458 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Fri, 26 Apr 2024 19:13:00 +0200 Subject: [PATCH] docs(website): Create the 'reference' page that links to Dokka --- docs/website/.gitlab-ci.yml | 1 + docs/website/docs/reference.md | 5 +++++ docs/website/mkdocs.yml | 3 +++ docs/website/overrides/redirect-to-reference.html | 13 +++++++++++++ 4 files changed, 22 insertions(+) create mode 100644 docs/website/docs/reference.md create mode 100644 docs/website/overrides/redirect-to-reference.html diff --git a/docs/website/.gitlab-ci.yml b/docs/website/.gitlab-ci.yml index cbe109a..1d51bd8 100644 --- a/docs/website/.gitlab-ci.yml +++ b/docs/website/.gitlab-ci.yml @@ -10,6 +10,7 @@ mkdocs: - ls - 'echo "repo_url: $CI_PROJECT_URL">>mkdocs.yml' - 'echo "repo_name: $CI_PROJECT_TITLE">>mkdocs.yml' + - 'echo "repo_pages: $CI_PAGES_URL">>mkdocs.yml' script: - pwd diff --git a/docs/website/docs/reference.md b/docs/website/docs/reference.md new file mode 100644 index 0000000..4036452 --- /dev/null +++ b/docs/website/docs/reference.md @@ -0,0 +1,5 @@ +--- +template: redirect-to-reference.html +--- + +# Reference diff --git a/docs/website/mkdocs.yml b/docs/website/mkdocs.yml index 112d0f9..d8312d8 100644 --- a/docs/website/mkdocs.yml +++ b/docs/website/mkdocs.yml @@ -69,3 +69,6 @@ nav: - Module1: [] - Module2: [] + + - Reference: + - reference.md diff --git a/docs/website/overrides/redirect-to-reference.html b/docs/website/overrides/redirect-to-reference.html new file mode 100644 index 0000000..9c6061c --- /dev/null +++ b/docs/website/overrides/redirect-to-reference.html @@ -0,0 +1,13 @@ + + + + + + {{ config.site_name }} + + + + + -- 2.51.2