From 64aaa7cda29196a9142dc8785c29201468429fe8 Mon Sep 17 00:00:00 2001 From: Wismill Date: Sun, 14 May 2023 15:11:15 +0200 Subject: Add support for stable doc URLs (#342) Doc URLs may change with time because they depend on Doxygen machinery. This is unfortunate because it is good practice to keep valid URLs (see: https://www.w3.org/Provider/Style/URI.html). I could not find a built-in solution in Doxygen, so the solution proposed here is to maintain a registry of all URLs and manage legacy URLs as redirections to their canonical page. This commit adds a registry of URLs that has three functions: - Check no previous URL is now invalid. - Add aliases for moved pages. - Generate redirection pages for aliases. The redirection works with a simple HTML tag. See: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta#http-equiv This commit also initialize the URLs registry with current pages and some redirections needed after recent documentation refactoring. Finally, the CI is updated to catch any change that invalidate previous URLs. --- .github/workflows/linux.yml | 2 +- .github/workflows/macos.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to '.github') diff --git a/.github/workflows/linux.yml b/.github/workflows/linux.yml index 5ba828f..aac3081 100644 --- a/.github/workflows/linux.yml +++ b/.github/workflows/linux.yml @@ -26,7 +26,7 @@ jobs: python-version: '3.9' - name: Install dependencies run: | - python -m pip install --upgrade meson + python -m pip install --upgrade meson PyYAML sudo apt update sudo apt install -y \ doxygen libxcb-xkb-dev valgrind ninja-build \ diff --git a/.github/workflows/macos.yml b/.github/workflows/macos.yml index c57a0d7..cde0989 100644 --- a/.github/workflows/macos.yml +++ b/.github/workflows/macos.yml @@ -23,7 +23,7 @@ jobs: python-version: '3.9' - name: Install dependencies run: | - python -m pip install --upgrade meson + python -m pip install --upgrade meson PyYAML brew install libxml2 doxygen bison ninja brew link bison --force env: -- cgit v1.2.1