diff --git a/.github/workflows/check_urls.yml b/.github/workflows/check_urls.yml index 6c45c041a..34c5fb943 100644 --- a/.github/workflows/check_urls.yml +++ b/.github/workflows/check_urls.yml @@ -24,13 +24,14 @@ jobs: uses: lycheeverse/lychee-action@v2 with: args: > - --base . + --root-dir . --no-progress --cache --max-cache-age 1d + --exclude-path _build/ --exclude-path _templates/ --exclude-path classes/ - "**/*.md" "**/*.html" "**/*.rst" + "**/*.md" "**/*.rst" - name: Fail if there were link errors run: exit ${{ steps.lc.outputs.exit_code }} diff --git a/.gitignore b/.gitignore index 939fcce39..1697aa045 100644 --- a/.gitignore +++ b/.gitignore @@ -61,3 +61,6 @@ tmp-unused-images-history # Jetbrains IDE files /.idea/ + +# Lychee URL checking cache +.lycheecache diff --git a/.lycheeignore b/.lycheeignore index 3c5eca4a6..4c49adedf 100644 --- a/.lycheeignore +++ b/.lycheeignore @@ -10,18 +10,27 @@ tcp:\/\/.* # Security checks prevent checking the URLs of these websites automatically, # typically returning 403 errors. .*asecuritysite\.com.* +.*computerhope\.com* +.*developer\.arm\.com.* +.*guru3d\.com.* +.*inkscape\.org.* .*intel\.com.* +.*itch\.io.* +.*khronos\.org.* +.*medium\.com.* .*reddit\.com.* -.*inkscape.org.* -.*computerhope.com* +.*shadertoy\.com.* # Don't check URLs from these websites due to frequent rate limits (error 429) or timeouts. .*adobe\.com.* +.*developer\.apple\.com.* +.*flathub\.org.* .*gamedevartisan\.com.* .*github\.com.* .*gnu\.org.* .*loopit\.dk.* .*meta\.com.* +.*nightly\.link.* .*sourceforge\.io.* # Not a valid URL with the GET method, which lychee always sends. diff --git a/engine_details/architecture/core_types.rst b/engine_details/architecture/core_types.rst index a2583eb40..113babc91 100644 --- a/engine_details/architecture/core_types.rst +++ b/engine_details/architecture/core_types.rst @@ -117,7 +117,7 @@ scripting API. | | | otherwise. | +-----------------------+--------------------------+---------------------------------------------------------------------------------------+ | |rb_map| | ``std::map`` | Map type that uses a | -| | | `red-black tree `__ to find keys. | +| | | `red-black tree `__ to find keys. | | | | The performance benefits of ``RBMap`` aren't established, so prefer using other types.| +-----------------------+--------------------------+---------------------------------------------------------------------------------------+ | |dictionary| 📜 | ``std::unordered_map`` | Keys and values can be of any Variant type. No static typing is imposed. | diff --git a/engine_details/engine_api/custom_modules_in_cpp.rst b/engine_details/engine_api/custom_modules_in_cpp.rst index 1bc01f9c5..2511546a7 100644 --- a/engine_details/engine_api/custom_modules_in_cpp.rst +++ b/engine_details/engine_api/custom_modules_in_cpp.rst @@ -466,7 +466,7 @@ Now if you go to the ``godot/modules/summator/doc_classes`` folder, you will see that it contains a ``Summator.xml`` file, or any other classes, that you referenced in your ``get_doc_classes`` function. -Edit the file(s) following the `class reference primer `__ and recompile the engine. +Edit the file(s) following the `class reference primer `__ and recompile the engine. Once the compilation process is finished, the docs will become accessible within the engine's built-in documentation system. diff --git a/tutorials/animation/creating_movies.rst b/tutorials/animation/creating_movies.rst index a7b12bd89..7017d976c 100644 --- a/tutorials/animation/creating_movies.rst +++ b/tutorials/animation/creating_movies.rst @@ -482,7 +482,7 @@ only 5.2 seconds of video after that point: ffmpeg -i input.avi -ss 00:00:12.10 -t 00:00:05.20 -crf 15 output.mp4 Cutting videos can also be done with the GUI tool -`LosslessCut `__. +`LosslessCut `__. Resizing video ~~~~~~~~~~~~~~ diff --git a/tutorials/animation/playing_videos.rst b/tutorials/animation/playing_videos.rst index 5f791dc8b..63368eaa5 100644 --- a/tutorials/animation/playing_videos.rst +++ b/tutorials/animation/playing_videos.rst @@ -208,9 +208,9 @@ below with almost any input video format (AVI, MOV, WebM, …). .. this warning can be removed. That will likely be FFmpeg 7.2 or 8.0, and will .. likely happen during the Godot 4.5 or 4.6 release cycle. .. Commits fixing the issues: -.. - https://github.org/FFmpeg/FFmpeg@22aa71d4da37a4ad2b0d28deeace64b57aa2ef50 -.. - https://github.org/FFmpeg/FFmpeg@84d85e7ad4ace228265af0c8c5caccc0730042fd -.. - https://github.org/FFmpeg/FFmpeg@6e26f57f672b05e7b8b052007a83aef99dc81ccb +.. - https://github.com/FFmpeg/FFmpeg/commit/22aa71d4da37a4ad2b0d28deeace64b57aa2ef50 +.. - https://github.com/FFmpeg/FFmpeg/commit/84d85e7ad4ace228265af0c8c5caccc0730042fd +.. - https://github.com/FFmpeg/FFmpeg/commit/6e26f57f672b05e7b8b052007a83aef99dc81ccb Balancing quality and file size ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/tutorials/export/exporting_for_android.rst b/tutorials/export/exporting_for_android.rst index 80f9413de..ed318ef3d 100644 --- a/tutorials/export/exporting_for_android.rst +++ b/tutorials/export/exporting_for_android.rst @@ -103,7 +103,7 @@ Launcher icons are used by Android launcher apps to represent your application t There are three types of icons: - **Main Icon:** The "classic" icon. This will be used on all Android versions up to Android 8 (Oreo), exclusive. Must be at least 192×192 px. -- **Adaptive Icons:** Starting from Android 8 (inclusive), `Adaptive Icons `_ were introduced. Applications will need to include separate background and foreground icons to have a native look. The user's launcher application will control the icon's animation and masking. Must be at least 432×432 px. +- **Adaptive Icons:** Starting from Android 8 (inclusive), `Adaptive Icons `_ were introduced. Applications will need to include separate background and foreground icons to have a native look. The user's launcher application will control the icon's animation and masking. Must be at least 432×432 px. - **Themed Icons (optional):** Starting from Android 13 (inclusive), Themed Icons were introduced. Applications will need to include a monochrome icon to enable this feature. The user's launcher application will control the icon's theme. Must be at least 432×432 px. .. seealso:: It's important to adhere to some rules when designing adaptive icons. `Google Design has provided a nice article `_ that helps to understand those rules and some of the capabilities of adaptive icons.