diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 7e580b0d7..de93034e0 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -14,6 +14,6 @@ assignees: '' If you know how to fix the issue you are reporting please consider opening a pull request. We provide a tutorial on -using git here: https://docs.godotengine.org/en/stable/community/contributing/pr_workflow.html, -writing documentation at https://docs.godotengine.org/en/stable/community/contributing/docs_writing_guidelines.html -and contributing to the class reference here: https://docs.godotengine.org/en/stable/community/contributing/updating_the_class_reference.html +using git here: https://contributing.godotengine.org/en/latest/organization/pull_requests/creating_pull_requests.html, +writing documentation at https://contributing.godotengine.org/en/latest/documentation/guidelines/index.html +and contributing to the class reference here: https://contributing.godotengine.org/en/latest/documentation/class_reference.html diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 806934458..8712366a6 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -6,7 +6,7 @@ repos: rev: v2.3.0 hooks: - id: codespell - files: ^(about|community|contributing|getting_started|tutorials)/.*\.rst$ + files: ^(about|community|engine_details|getting_started|tutorials)/.*\.rst$ additional_dependencies: [tomli] - repo: https://github.com/pre-commit/pre-commit-hooks diff --git a/README.md b/README.md index bf2223d19..930d03838 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ Here are some quick links to the areas you might be interested in: 3. [Content guidelines](https://docs.godotengine.org/en/latest/contributing/documentation/content_guidelines.html) 4. [Writing guidelines](https://docs.godotengine.org/en/latest/contributing/documentation/docs_writing_guidelines.html) 5. [Building the manual](https://docs.godotengine.org/en/latest/contributing/documentation/building_the_manual.html) -6. [Translating the documentation](https://docs.godotengine.org/en/latest/contributing/documentation/editor_and_docs_localization.html) +6. [Translating the documentation](https://contributing.godotengine.org/en/latest/documentation/translation/index.html) ## License diff --git a/_styleguides/de.md b/_styleguides/de.md index 649cdcefe..a75364c66 100644 --- a/_styleguides/de.md +++ b/_styleguides/de.md @@ -8,7 +8,7 @@ Lesbarkeit, Klarheit und Benutzbarkeit besonders im Vordergrund stehen. Für die Übersetzung selbst ist das Tool [Weblate](https://hosted.weblate.org/projects/godot-engine/) im Einsatz, das in der -[offiziellen Dokumentation](https://docs.godotengine.org/de/4.x/contributing/documentation/editor_and_docs_localization.html) näher +[offiziellen Dokumentation](https://contributing.godotengine.org/en/latest/documentation/translation/index.html) näher erläutert wird. Die Bedienung von Weblate ist nicht Bestandteil dieses Dokuments. @@ -357,8 +357,8 @@ mit übersetzt werden sollten. Für Übersetzungen des Editors und der Properties ist es ratsam, diese auch selbst zu testen, indem -man [die aktuelle Übersetzung herunterlädt](https://docs.godotengine.org/de/4.x/contributing/documentation/editor_and_docs_localization.html#offline-translation-and-testing) -und Godot mit den Änderungen [selbst kompiliert](https://docs.godotengine.org/de/4.x/contributing/development/compiling/compiling_for_windows.html). +man [die aktuelle Übersetzung herunterlädt](https://contributing.godotengine.org/en/latest/documentation/translation/index.html#offline-translation-and-testing) +und Godot mit den Änderungen [selbst kompiliert](https://docs.godotengine.org/de/4.x/engine_details/development/compiling/compiling_for_windows.html). Gerade bei der Anleitung kommt es oft auf den Kontext zwischen benachbarten Textblöcken an, sodass das Lesen eines ganzen Artikels Fehler sichtbar diff --git a/_templates/breadcrumbs.html b/_templates/breadcrumbs.html index d7e3dfd38..bf1f8389a 100644 --- a/_templates/breadcrumbs.html +++ b/_templates/breadcrumbs.html @@ -32,7 +32,7 @@ } } - + Learn how to contribute! diff --git a/_tools/redirects/redirects.csv b/_tools/redirects/redirects.csv index 31930a3fe..0842f4660 100644 --- a/_tools/redirects/redirects.csv +++ b/_tools/redirects/redirects.csv @@ -2,22 +2,6 @@ source,destination /about/index.html,/index.html /about/troubleshooting.html,/tutorials/troubleshooting.html /classes/_classes.html,/classes/ -/community/contributing/best_practices_for_engine_contributors.html,/contributing/development/best_practices_for_engine_contributors.html -/community/contributing/bisecting_regressions.html,/contributing/workflow/bisecting_regressions.html -/community/contributing/bug_triage_guidelines.html,/contributing/workflow/bug_triage_guidelines.html -/community/contributing/building_the_manual.html,/contributing/documentation/building_the_manual.html -/community/contributing/class_reference_writing_guidelines.html,/contributing/documentation/class_reference_primer.html -/community/contributing/code_style_guidelines.html,/contributing/development/code_style_guidelines.html -/community/contributing/content_guidelines.html,/contributing/documentation/content_guidelines.html -/community/contributing/contributing_to_the_documentation.html,/contributing/documentation/contributing_to_the_documentation.html -/community/contributing/cpp_usage_guidelines.html,/contributing/development/cpp_usage_guidelines.html -/community/contributing/docs_writing_guidelines.html,/contributing/documentation/docs_writing_guidelines.html -/community/contributing/editor_and_docs_localization.html,/contributing/documentation/editor_and_docs_localization.html -/community/contributing/index.html,/contributing/ways_to_contribute.html -/community/contributing/pr_workflow.html,/contributing/workflow/pr_workflow.html -/community/contributing/testing_pull_requests.html,/contributing/workflow/testing_pull_requests.html -/community/contributing/updating_the_class_reference.html,/contributing/documentation/updating_the_class_reference.html -/community/contributing/ways_to_contribute.html,/contributing/ways_to_contribute.html /community/tutorials/3d/mesh_generation_with_heightmap_and_shaders.html,/tutorials/3d/mesh_generation_with_heightmap_and_shaders.html /community/tutorials/gdnative/gdnative-c-example.html,/tutorials/plugins/gdnative/gdnative-c-example.html /community/tutorials/gdnative/index.html,/tutorials/plugins/gdnative/index.html @@ -25,61 +9,56 @@ source,destination /community/tutorials/vr/vr_primer.html,/tutorials/vr/vr_primer.html /content/3d/making_trees.html,/tutorials/content/making_trees.html /contributing/_contributing.html,/community/contributing/ -/contributing/bug_triage_guidelines.html,/community/contributing/bug_triage_guidelines.html -/contributing/development/compiling/compiling_with_mono.html,/contributing/development/compiling/compiling_with_dotnet.html -/contributing/development/core_and_modules/introduction_to_godot_development.html,/contributing/development/core_and_modules/index.html -/contributing/doc_and_l10n_guidelines.html,/community/contributing/doc_and_l10n_guidelines.html -/contributing/updating_the_class_reference.html,/community/contributing/updating_the_class_reference.html -/contributing/ways_to_contribute.html,/contributing/how_to_contribute.html -/development/compiling/compiling_for_android.html,/contributing/development/compiling/compiling_for_android.html -/development/compiling/compiling_for_ios.html,/contributing/development/compiling/compiling_for_ios.html -/development/compiling/compiling_for_linuxbsd.html,/contributing/development/compiling/compiling_for_linuxbsd.html -/development/compiling/compiling_for_macos.html,/contributing/development/compiling/compiling_for_macos.html -/development/compiling/compiling_for_uwp.html,/contributing/development/compiling/compiling_for_uwp.html -/development/compiling/compiling_for_web.html,/contributing/development/compiling/compiling_for_web.html -/development/compiling/compiling_for_windows.html,/contributing/development/compiling/compiling_for_windows.html -/development/compiling/compiling_for_x11.html,/contributing/development/compiling/compiling_for_linuxbsd.html -/development/compiling/compiling_with_mono.html,/contributing/development/compiling/compiling_with_mono.html -/development/compiling/compiling_with_script_encryption_key.html,/contributing/development/compiling/compiling_with_script_encryption_key.html -/development/compiling/cross-compiling_for_ios_on_linux.html,/contributing/development/compiling/cross-compiling_for_ios_on_linux.html -/development/compiling/getting_source.html,/contributing/development/compiling/getting_source.html -/development/compiling/index.html,/contributing/development/compiling/index.html -/development/compiling/introduction_to_the_buildsystem.html,/contributing/development/compiling/introduction_to_the_buildsystem.html -/development/compiling/optimizing_for_size.html,/contributing/development/compiling/optimizing_for_size.html +/contributing/development/compiling/compiling_with_mono.html,/engine_details/development/compiling/compiling_with_dotnet.html +/contributing/development/core_and_modules/introduction_to_godot_development.html,/engine_details/development/core_and_modules/index.html +/development/compiling/compiling_for_android.html,/engine_details/development/compiling/compiling_for_android.html +/development/compiling/compiling_for_ios.html,/engine_details/development/compiling/compiling_for_ios.html +/development/compiling/compiling_for_linuxbsd.html,/engine_details/development/compiling/compiling_for_linuxbsd.html +/development/compiling/compiling_for_macos.html,/engine_details/development/compiling/compiling_for_macos.html +/development/compiling/compiling_for_uwp.html,/engine_details/development/compiling/compiling_for_uwp.html +/development/compiling/compiling_for_web.html,/engine_details/development/compiling/compiling_for_web.html +/development/compiling/compiling_for_windows.html,/engine_details/development/compiling/compiling_for_windows.html +/development/compiling/compiling_for_x11.html,/engine_details/development/compiling/compiling_for_linuxbsd.html +/development/compiling/compiling_with_mono.html,/engine_details/development/compiling/compiling_with_mono.html +/development/compiling/compiling_with_script_encryption_key.html,/engine_details/development/compiling/compiling_with_script_encryption_key.html +/development/compiling/cross-compiling_for_ios_on_linux.html,/engine_details/development/compiling/cross-compiling_for_ios_on_linux.html +/development/compiling/getting_source.html,/engine_details/development/compiling/getting_source.html +/development/compiling/index.html,/engine_details/development/compiling/index.html +/development/compiling/introduction_to_the_buildsystem.html,/engine_details/development/compiling/introduction_to_the_buildsystem.html +/development/compiling/optimizing_for_size.html,/engine_details/development/compiling/optimizing_for_size.html /development/consoles/consoles.html,/tutorials/platform/consoles.html -/development/cpp/binding_to_external_libraries.html,/contributing/development/core_and_modules/binding_to_external_libraries.html -/development/cpp/common_engine_methods_and_macros.html,/contributing/development/core_and_modules/common_engine_methods_and_macros.html -/development/cpp/configuring_an_ide/android_studio.html,/contributing/development/configuring_an_ide/android_studio.html -/development/cpp/configuring_an_ide/clion.html,/contributing/development/configuring_an_ide/clion.html -/development/cpp/configuring_an_ide/code_blocks.html,/contributing/development/configuring_an_ide/code_blocks.html -/development/cpp/configuring_an_ide/index.html,/contributing/development/configuring_an_ide/index.html -/development/cpp/configuring_an_ide/kdevelop.html,/contributing/development/configuring_an_ide/kdevelop.html -/development/cpp/configuring_an_ide/qt_creator.html,/contributing/development/configuring_an_ide/qt_creator.html -/development/cpp/configuring_an_ide/visual_studio.html,/contributing/development/configuring_an_ide/visual_studio.html -/development/cpp/configuring_an_ide/visual_studio_code.html,/contributing/development/configuring_an_ide/visual_studio_code.html -/development/cpp/configuring_an_ide/xcode.html,/contributing/development/configuring_an_ide/xcode.html -/development/cpp/core_types.html,/contributing/development/core_and_modules/core_types.html -/development/cpp/custom_audiostreams.html,/contributing/development/core_and_modules/custom_audiostreams.html -/development/cpp/custom_godot_servers.html,/contributing/development/core_and_modules/custom_godot_servers.html -/development/cpp/custom_modules_in_cpp.html,/contributing/development/core_and_modules/custom_modules_in_cpp.html +/development/cpp/binding_to_external_libraries.html,/engine_details/development/core_and_modules/binding_to_external_libraries.html +/development/cpp/common_engine_methods_and_macros.html,/engine_details/development/core_and_modules/common_engine_methods_and_macros.html +/development/cpp/configuring_an_ide/android_studio.html,/engine_details/development/configuring_an_ide/android_studio.html +/development/cpp/configuring_an_ide/clion.html,/engine_details/development/configuring_an_ide/clion.html +/development/cpp/configuring_an_ide/code_blocks.html,/engine_details/development/configuring_an_ide/code_blocks.html +/development/cpp/configuring_an_ide/index.html,/engine_details/development/configuring_an_ide/index.html +/development/cpp/configuring_an_ide/kdevelop.html,/engine_details/development/configuring_an_ide/kdevelop.html +/development/cpp/configuring_an_ide/qt_creator.html,/engine_details/development/configuring_an_ide/qt_creator.html +/development/cpp/configuring_an_ide/visual_studio.html,/engine_details/development/configuring_an_ide/visual_studio.html +/development/cpp/configuring_an_ide/visual_studio_code.html,/engine_details/development/configuring_an_ide/visual_studio_code.html +/development/cpp/configuring_an_ide/xcode.html,/engine_details/development/configuring_an_ide/xcode.html +/development/cpp/core_types.html,/engine_details/development/core_and_modules/core_types.html +/development/cpp/custom_audiostreams.html,/engine_details/development/core_and_modules/custom_audiostreams.html +/development/cpp/custom_godot_servers.html,/engine_details/development/core_and_modules/custom_godot_servers.html +/development/cpp/custom_modules_in_cpp.html,/engine_details/development/core_and_modules/custom_modules_in_cpp.html /development/cpp/custom_resource_format_loaders.html,/contributing/development/core_and_modules/custom_resource_format_loaders.html -/development/cpp/index.html,/contributing/development/core_and_modules/index.html -/development/cpp/inheritance_class_tree.html,/contributing/development/core_and_modules/inheritance_class_tree.html -/development/cpp/introduction_to_godot_development.html,/contributing/development/core_and_modules/introduction_to_godot_development.html -/development/cpp/macos_debug.html,/contributing/development/debugging/macos_debug.html -/development/cpp/object_class.html,/contributing/development/core_and_modules/object_class.html -/development/cpp/unit_testing.html,/contributing/development/core_and_modules/unit_testing.html -/development/cpp/using_cpp_profilers.html,/contributing/development/debugging/using_cpp_profilers.html -/development/cpp/variant_class.html,/contributing/development/core_and_modules/variant_class.html -/development/cpp/vulkan/index.html,/contributing/development/debugging/vulkan/index.html -/development/cpp/vulkan/vulkan_validation_layers.html,/contributing/development/debugging/vulkan/vulkan_validation_layers.html -/development/editor/creating_icons.html,/contributing/development/editor/creating_icons.html -/development/editor/editor_style_guide.html,/contributing/development/editor/editor_style_guide.html -/development/editor/index.html,/contributing/development/editor/index.html -/development/editor/introduction_to_editor_development.html,/contributing/development/editor/introduction_to_editor_development.html -/development/file_formats/gdscript_grammar.html,/contributing/development/file_formats/gdscript_grammar.html -/development/file_formats/index.html,/contributing/development/file_formats/index.html -/development/file_formats/tscn.html,/contributing/development/file_formats/tscn.html +/development/cpp/index.html,/engine_details/development/core_and_modules/index.html +/development/cpp/inheritance_class_tree.html,/engine_details/development/core_and_modules/inheritance_class_tree.html +/development/cpp/introduction_to_godot_development.html,/engine_details/development/core_and_modules/introduction_to_godot_development.html +/development/cpp/macos_debug.html,/engine_details/development/debugging/macos_debug.html +/development/cpp/object_class.html,/engine_details/development/core_and_modules/object_class.html +/development/cpp/unit_testing.html,/engine_details/development/core_and_modules/unit_testing.html +/development/cpp/using_cpp_profilers.html,/engine_details/development/debugging/using_cpp_profilers.html +/development/cpp/variant_class.html,/engine_details/development/core_and_modules/variant_class.html +/development/cpp/vulkan/index.html,/engine_details/development/debugging/vulkan/index.html +/development/cpp/vulkan/vulkan_validation_layers.html,/engine_details/development/debugging/vulkan/vulkan_validation_layers.html +/development/editor/creating_icons.html,/engine_details/editor/creating_icons.html +/development/editor/index.html,/engine_details/editor/index.html +/development/editor/introduction_to_editor_development.html,/engine_details/editor/introduction_to_editor_development.html +/development/file_formats/gdscript_grammar.html,/engine_details/development/file_formats/gdscript_grammar.html +/development/file_formats/index.html,/engine_details/development/file_formats/index.html +/development/file_formats/tscn.html,/engine_details/development/file_formats/tscn.html /development/plugins/import_plugins.html,/tutorials/plugins/editor/import_plugins.html /development/plugins/index.html,/tutorials/plugins/editor/index.html /development/plugins/making_plugins.html,/tutorials/plugins/editor/making_plugins.html diff --git a/about/complying_with_licenses.rst b/about/complying_with_licenses.rst index 8f58eccfd..0ce3a63d3 100644 --- a/about/complying_with_licenses.rst +++ b/about/complying_with_licenses.rst @@ -27,7 +27,7 @@ with the original one. This section covers compliance with licenses from a user perspective. If you are interested in licence compliance as a contributor, you can find - guidelines :ref:`here `. + guidelines `here `__. .. tip:: diff --git a/about/docs_changelog.rst b/about/docs_changelog.rst index 5a792dab5..4497b294f 100644 --- a/about/docs_changelog.rst +++ b/about/docs_changelog.rst @@ -78,7 +78,6 @@ Contributing ~~~~~~~~~~~~ - :ref:`doc_handling_compatibility_breakages` -- :ref:`doc_ways_to_contribute` GDExtension ~~~~~~~~~~~ @@ -215,11 +214,6 @@ Shaders - :ref:`doc_compute_shaders` -Workflow -~~~~~~~~ - -- :ref:`doc_pr_review_guidelines` - XR ~~ @@ -253,11 +247,6 @@ Editor New pages since version 3.3 --------------------------- -C++ -~~~ - -- :ref:`doc_cpp_usage_guidelines` - GDScript ~~~~~~~~ @@ -283,19 +272,10 @@ Best practices - :ref:`doc_version_control_systems` -Community -~~~~~~~~~ - -- :ref:`doc_best_practices_for_engine_contributors` -- :ref:`doc_bisecting_regressions` -- :ref:`doc_editor_and_docs_localization` - Development ~~~~~~~~~~~ -- :ref:`doc_introduction_to_editor_development` -- :ref:`doc_editor_style_guide` -- :ref:`doc_common_engine_methods_and_macros` +- :ref:`doc_common_engine_methods_and_macros_error_macros` - :ref:`doc_vulkan_validation_layers` - :ref:`doc_gdscript_grammar` - Configuring an IDE: :ref:`doc_configuring_an_ide_code_blocks` diff --git a/about/faq.rst b/about/faq.rst index 6f8853e36..1b8a76a3a 100644 --- a/about/faq.rst +++ b/about/faq.rst @@ -448,7 +448,7 @@ compile the engine from sources, or how to build the documentation. You also nee get familiar with Git, a version control system that Godot developers use. We explain how to work with the engine source, how to edit the documentation, and -what other ways to contribute are there in our :ref:`documentation for contributors `. +what other ways to contribute are there in our `documentation for contributors `__. I have a great idea for Godot. How can I share it? -------------------------------------------------- @@ -629,7 +629,7 @@ for the rest of the game. How can I support Godot development or contribute? -------------------------------------------------- -See :ref:`doc_ways_to_contribute`. +See `How to contribute `__. Who is working on Godot? How can I contact you? ----------------------------------------------- diff --git a/about/introduction.rst b/about/introduction.rst index 20c188474..31b30bfd0 100644 --- a/about/introduction.rst +++ b/about/introduction.rst @@ -100,8 +100,8 @@ About this documentation Members of the Godot Engine community continuously write, correct, edit, and improve this documentation. We are always looking for more help. You can also contribute by opening Github issues or translating the documentation into your language. -If you are interested in helping, see :ref:`Ways to contribute ` -and :ref:`Writing documentation `, +If you are interested in helping, see `How to contribute `__ +and `Writing documentation `__, or get in touch with the `Documentation team `_ on `Godot Contributors Chat `_. diff --git a/about/list_of_features.rst b/about/list_of_features.rst index 77110ce84..b3fcee157 100644 --- a/about/list_of_features.rst +++ b/about/list_of_features.rst @@ -788,7 +788,7 @@ Miscellaneous - Licensed under the permissive MIT license. - - Open development process with :ref:`contributions welcome `. + - Open development process with `contributions welcome `__. .. seealso:: diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index ff27ab5bb..afbadf708 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -436,7 +436,7 @@ Sets a name for a given surface. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -450,7 +450,7 @@ Sets a name for a given surface. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -464,7 +464,7 @@ Sets a name for a given surface. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index db80798e7..92dff8bb2 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -607,7 +607,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -621,7 +621,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -635,7 +635,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -649,7 +649,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -663,7 +663,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -677,7 +677,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -691,7 +691,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -705,7 +705,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -719,7 +719,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -733,7 +733,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -747,7 +747,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -761,7 +761,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst index 9724fae5d..f5fffb1af 100644 --- a/classes/class_audioeffectdistortion.rst +++ b/classes/class_audioeffectdistortion.rst @@ -83,7 +83,7 @@ Digital distortion effect which cuts off peaks at the top and bottom of the wave .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index 0a9b64b54..652e2dd42 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -106,7 +106,7 @@ Applies a gain to the limited waves, in decibels. Value can range from 0 to 6. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_audioeffectspectrumanalyzer.rst b/classes/class_audioeffectspectrumanalyzer.rst index 165c49caf..b769cec6f 100644 --- a/classes/class_audioeffectspectrumanalyzer.rst +++ b/classes/class_audioeffectspectrumanalyzer.rst @@ -167,7 +167,7 @@ The size of the `Fast Fourier transform `! + There is currently no description for this property. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_audiostreammp3.rst b/classes/class_audiostreammp3.rst index a7a016823..699e061f5 100644 --- a/classes/class_audiostreammp3.rst +++ b/classes/class_audiostreammp3.rst @@ -81,7 +81,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -100,7 +100,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -119,7 +119,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index a28750514..e78ffb550 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -88,7 +88,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -107,7 +107,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -126,7 +126,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_audiostreamplaybackoggvorbis.rst b/classes/class_audiostreamplaybackoggvorbis.rst index e89c61e18..3990b7339 100644 --- a/classes/class_audiostreamplaybackoggvorbis.rst +++ b/classes/class_audiostreamplaybackoggvorbis.rst @@ -14,7 +14,7 @@ AudioStreamPlaybackOggVorbis .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_audiostreamplaybackresampled.rst b/classes/class_audiostreamplaybackresampled.rst index 9fcafec2c..985117987 100644 --- a/classes/class_audiostreamplaybackresampled.rst +++ b/classes/class_audiostreamplaybackresampled.rst @@ -16,7 +16,7 @@ AudioStreamPlaybackResampled .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -51,7 +51,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -65,7 +65,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -79,7 +79,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_audiostreamplaybacksynchronized.rst b/classes/class_audiostreamplaybacksynchronized.rst index 4f3977235..fe251137d 100644 --- a/classes/class_audiostreamplaybacksynchronized.rst +++ b/classes/class_audiostreamplaybacksynchronized.rst @@ -14,7 +14,7 @@ AudioStreamPlaybackSynchronized .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_editorexportplatformvisionos.rst b/classes/class_editorexportplatformvisionos.rst index 9c0f6936c..b6435efbc 100644 --- a/classes/class_editorexportplatformvisionos.rst +++ b/classes/class_editorexportplatformvisionos.rst @@ -551,7 +551,7 @@ Interpolation method used to resize application icon. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_editorexportpreset.rst b/classes/class_editorexportpreset.rst index 4ec300158..2de3a8be9 100644 --- a/classes/class_editorexportpreset.rst +++ b/classes/class_editorexportpreset.rst @@ -104,7 +104,7 @@ enum **ExportFilter**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -116,7 +116,7 @@ enum **ExportFilter**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -128,7 +128,7 @@ enum **ExportFilter**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -140,7 +140,7 @@ enum **ExportFilter**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -152,7 +152,7 @@ enum **ExportFilter**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -174,7 +174,7 @@ enum **FileExportMode**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -186,7 +186,7 @@ enum **FileExportMode**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -198,7 +198,7 @@ enum **FileExportMode**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -210,7 +210,7 @@ enum **FileExportMode**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -232,7 +232,7 @@ enum **ScriptExportMode**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -244,7 +244,7 @@ enum **ScriptExportMode**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -256,7 +256,7 @@ enum **ScriptExportMode**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! diff --git a/classes/class_editornode3dgizmo.rst b/classes/class_editornode3dgizmo.rst index 4f909c5cc..889738961 100644 --- a/classes/class_editornode3dgizmo.rst +++ b/classes/class_editornode3dgizmo.rst @@ -98,7 +98,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_editornode3dgizmoplugin.rst b/classes/class_editornode3dgizmoplugin.rst index 219e27bfa..3ec09a30e 100644 --- a/classes/class_editornode3dgizmoplugin.rst +++ b/classes/class_editornode3dgizmoplugin.rst @@ -103,7 +103,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_editorsceneformatimporter.rst b/classes/class_editorsceneformatimporter.rst index d4cb45a0e..ce7cbb9cf 100644 --- a/classes/class_editorsceneformatimporter.rst +++ b/classes/class_editorsceneformatimporter.rst @@ -64,7 +64,7 @@ Constants .. container:: contribute - There is currently no description for this constant. Please help us by :ref:`contributing one `! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -76,7 +76,7 @@ Constants .. container:: contribute - There is currently no description for this constant. Please help us by :ref:`contributing one `! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -88,7 +88,7 @@ Constants .. container:: contribute - There is currently no description for this constant. Please help us by :ref:`contributing one `! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -100,7 +100,7 @@ Constants .. container:: contribute - There is currently no description for this constant. Please help us by :ref:`contributing one `! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -112,7 +112,7 @@ Constants .. container:: contribute - There is currently no description for this constant. Please help us by :ref:`contributing one `! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -124,7 +124,7 @@ Constants .. container:: contribute - There is currently no description for this constant. Please help us by :ref:`contributing one `! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -136,7 +136,7 @@ Constants .. container:: contribute - There is currently no description for this constant. Please help us by :ref:`contributing one `! + There is currently no description for this constant. Please help us by `contributing one `__! diff --git a/classes/class_editorsceneformatimportergltf.rst b/classes/class_editorsceneformatimportergltf.rst index ff699d671..ce2949965 100644 --- a/classes/class_editorsceneformatimportergltf.rst +++ b/classes/class_editorsceneformatimportergltf.rst @@ -14,7 +14,7 @@ EditorSceneFormatImporterGLTF .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_editorscenepostimportplugin.rst b/classes/class_editorscenepostimportplugin.rst index 17ab1ab8d..43c6e6c65 100644 --- a/classes/class_editorscenepostimportplugin.rst +++ b/classes/class_editorscenepostimportplugin.rst @@ -76,7 +76,7 @@ enum **InternalImportCategory**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -88,7 +88,7 @@ enum **InternalImportCategory**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -100,7 +100,7 @@ enum **InternalImportCategory**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -112,7 +112,7 @@ enum **InternalImportCategory**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -124,7 +124,7 @@ enum **InternalImportCategory**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -136,7 +136,7 @@ enum **InternalImportCategory**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -148,7 +148,7 @@ enum **InternalImportCategory**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -160,7 +160,7 @@ enum **InternalImportCategory**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 04171a8b5..51f383636 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -2457,7 +2457,7 @@ The modulate color to use for "past" frames displayed in the animation editor's .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2471,7 +2471,7 @@ The modulate color to use for "past" frames displayed in the animation editor's .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2485,7 +2485,7 @@ The modulate color to use for "past" frames displayed in the animation editor's .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2499,7 +2499,7 @@ The modulate color to use for "past" frames displayed in the animation editor's .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3606,7 +3606,7 @@ Tab style of editor docks. The language to use for the editor interface. -Translations are provided by the community. If you spot a mistake, :doc:`contribute to editor translations on Weblate! <../contributing/documentation/editor_and_docs_localization>` +Translations are provided by the community. If you spot a mistake, `contribute to editor translations on Weblate! `__ .. rst-class:: classref-item-separator diff --git a/classes/class_generic6dofjoint3d.rst b/classes/class_generic6dofjoint3d.rst index c2ba80dd1..2909bc0cd 100644 --- a/classes/class_generic6dofjoint3d.rst +++ b/classes/class_generic6dofjoint3d.rst @@ -314,7 +314,7 @@ The maximum force the linear motor will apply while trying to reach the velocity .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -326,7 +326,7 @@ The maximum force the linear motor will apply while trying to reach the velocity .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -338,7 +338,7 @@ The maximum force the linear motor will apply while trying to reach the velocity .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -422,7 +422,7 @@ Maximum acceleration for the motor at the axes. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -434,7 +434,7 @@ Maximum acceleration for the motor at the axes. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -446,7 +446,7 @@ Maximum acceleration for the motor at the axes. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -492,7 +492,7 @@ If enabled, rotational motion is possible within the given limits. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -504,7 +504,7 @@ If enabled, rotational motion is possible within the given limits. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1117,7 +1117,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1136,7 +1136,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1155,7 +1155,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1174,7 +1174,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1193,7 +1193,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1212,7 +1212,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1231,7 +1231,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1250,7 +1250,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1269,7 +1269,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1288,7 +1288,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1307,7 +1307,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1326,7 +1326,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1804,7 +1804,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1823,7 +1823,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1842,7 +1842,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1861,7 +1861,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1880,7 +1880,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1899,7 +1899,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1918,7 +1918,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1937,7 +1937,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1956,7 +1956,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1975,7 +1975,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1994,7 +1994,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2013,7 +2013,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-section-separator @@ -2032,7 +2032,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2046,7 +2046,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2060,7 +2060,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2074,7 +2074,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2088,7 +2088,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2102,7 +2102,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2116,7 +2116,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2130,7 +2130,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2144,7 +2144,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2158,7 +2158,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2172,7 +2172,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2186,7 +2186,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_gltfanimation.rst b/classes/class_gltfanimation.rst index 28969ef83..3e72b9653 100644 --- a/classes/class_gltfanimation.rst +++ b/classes/class_gltfanimation.rst @@ -14,7 +14,7 @@ GLTFAnimation .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-introduction-group @@ -73,7 +73,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_gltfdocumentextensionconvertimportermesh.rst b/classes/class_gltfdocumentextensionconvertimportermesh.rst index 4871118df..af9e48fec 100644 --- a/classes/class_gltfdocumentextensionconvertimportermesh.rst +++ b/classes/class_gltfdocumentextensionconvertimportermesh.rst @@ -14,7 +14,7 @@ GLTFDocumentExtensionConvertImporterMesh .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-introduction-group diff --git a/classes/class_gltflight.rst b/classes/class_gltflight.rst index c1491b36b..2b7071c28 100644 --- a/classes/class_gltflight.rst +++ b/classes/class_gltflight.rst @@ -228,7 +228,7 @@ Create a new GLTFLight instance from the given Godot :ref:`Light3D`! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -242,7 +242,7 @@ Create a new GLTFLight instance from the given Godot :ref:`Light3D`! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_gltfskeleton.rst b/classes/class_gltfskeleton.rst index 1fe62b541..970ef5f3c 100644 --- a/classes/class_gltfskeleton.rst +++ b/classes/class_gltfskeleton.rst @@ -14,7 +14,7 @@ GLTFSkeleton .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-introduction-group @@ -83,7 +83,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt32Array` for more details. @@ -104,7 +104,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt32Array` for more details. @@ -125,7 +125,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -139,7 +139,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -165,7 +165,7 @@ Returns a :ref:`Dictionary` that maps skeleton bone indices to .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -179,7 +179,7 @@ Returns a :ref:`Dictionary` that maps skeleton bone indices to .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -205,7 +205,7 @@ Sets a :ref:`Dictionary` that maps skeleton bone indices to th .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_gltfskin.rst b/classes/class_gltfskin.rst index 646bbb4e6..7722d7057 100644 --- a/classes/class_gltfskin.rst +++ b/classes/class_gltfskin.rst @@ -14,7 +14,7 @@ GLTFSkin .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-introduction-group @@ -91,7 +91,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -110,7 +110,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt32Array` for more details. @@ -131,7 +131,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt32Array` for more details. @@ -152,7 +152,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt32Array` for more details. @@ -173,7 +173,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt32Array` for more details. @@ -194,7 +194,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -213,7 +213,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-section-separator @@ -232,7 +232,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -246,7 +246,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -260,7 +260,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -274,7 +274,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -288,7 +288,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -302,7 +302,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_gltfstate.rst b/classes/class_gltfstate.rst index f35b92e4e..494f3b2f5 100644 --- a/classes/class_gltfstate.rst +++ b/classes/class_gltfstate.rst @@ -261,7 +261,7 @@ The folder path associated with this glTF data. This is used to find other files .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -297,7 +297,7 @@ The copyright string in the asset header of the glTF file. This is set during im .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -386,7 +386,7 @@ The original raw JSON document corresponding to this GLTFState. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -405,7 +405,7 @@ The original raw JSON document corresponding to this GLTFState. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -460,7 +460,7 @@ The name of the scene. When importing, if not specified, this will be the file n .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-section-separator @@ -519,7 +519,7 @@ The ``parent_node_index`` parameter is the index of the parent :ref:`GLTFNode`! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -583,7 +583,7 @@ Returns an array of all :ref:`GLTFAnimation`\ s in the glTF .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -609,7 +609,7 @@ Returns an array of all :ref:`GLTFCamera`\ s in the glTF file. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -647,7 +647,7 @@ Returns an array of all :ref:`GLTFLight`\ s in the glTF file. T .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -749,7 +749,7 @@ Retrieves the array of texture samplers that are used by the textures contained .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -787,7 +787,7 @@ Returns an array of unique node names. This is used in both the import process a .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -827,7 +827,7 @@ Sets the :ref:`GLTFAnimation`\ s in the state. When importi .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -853,7 +853,7 @@ Sets the :ref:`GLTFCamera`\ s in the state. These are the came .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -891,7 +891,7 @@ Sets the :ref:`GLTFLight`\ s in the state. These are the lights .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -965,7 +965,7 @@ Sets the array of texture samplers that are used by the textures contained in th .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_gpuparticles3d.rst b/classes/class_gpuparticles3d.rst index 1ba6ef263..14d4def27 100644 --- a/classes/class_gpuparticles3d.rst +++ b/classes/class_gpuparticles3d.rst @@ -264,7 +264,7 @@ enum **TransformAlign**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -276,7 +276,7 @@ enum **TransformAlign**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -288,7 +288,7 @@ enum **TransformAlign**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -300,7 +300,7 @@ enum **TransformAlign**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -504,7 +504,7 @@ The number of draw passes when rendering particles. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -826,7 +826,7 @@ The amount of time the particle's trail should represent (in seconds). Only effe .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index fb5e2bd22..751dd4bd7 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -1664,7 +1664,7 @@ The icon for the zoom reset button. .. container:: contribute - There is currently no description for this theme property. Please help us by :ref:`contributing one `! + There is currently no description for this theme property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index be035190b..123bdf3d7 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -265,7 +265,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_imageformatloader.rst b/classes/class_imageformatloader.rst index 235d1e905..9cc3d9d9d 100644 --- a/classes/class_imageformatloader.rst +++ b/classes/class_imageformatloader.rst @@ -46,7 +46,7 @@ flags **LoaderFlags**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -58,7 +58,7 @@ flags **LoaderFlags**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -70,7 +70,7 @@ flags **LoaderFlags**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! diff --git a/classes/class_importermeshinstance3d.rst b/classes/class_importermeshinstance3d.rst index d79acfc93..4b90a365e 100644 --- a/classes/class_importermeshinstance3d.rst +++ b/classes/class_importermeshinstance3d.rst @@ -14,7 +14,7 @@ ImporterMeshInstance3D .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -68,7 +68,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -87,7 +87,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -106,7 +106,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -125,7 +125,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -144,7 +144,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -163,7 +163,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -182,7 +182,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -201,7 +201,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -220,7 +220,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -239,7 +239,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_javascriptbridge.rst b/classes/class_javascriptbridge.rst index 69799ce87..59f4be3c9 100644 --- a/classes/class_javascriptbridge.rst +++ b/classes/class_javascriptbridge.rst @@ -21,7 +21,7 @@ Description The JavaScriptBridge singleton is implemented only in the Web export. It's used to access the browser's JavaScript context. This allows interaction with embedding pages or calling third-party JavaScript APIs. -\ **Note:** This singleton can be disabled at build-time to improve security. By default, the JavaScriptBridge singleton is enabled. Official export templates also have the JavaScriptBridge singleton enabled. See :doc:`Compiling for the Web <../contributing/development/compiling/compiling_for_web>` in the documentation for more information. +\ **Note:** This singleton can be disabled at build-time to improve security. By default, the JavaScriptBridge singleton is enabled. Official export templates also have the JavaScriptBridge singleton enabled. See :doc:`Compiling for the Web <../engine_details/development/compiling/compiling_for_web>` in the documentation for more information. .. rst-class:: classref-introduction-group diff --git a/classes/class_jsonrpc.rst b/classes/class_jsonrpc.rst index aa7e9d83c..55d0ac301 100644 --- a/classes/class_jsonrpc.rst +++ b/classes/class_jsonrpc.rst @@ -201,7 +201,7 @@ To add new supported methods extend the JSONRPC class and call :ref:`process_act .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_light3d.rst b/classes/class_light3d.rst index e489bb725..e2f9ebc6a 100644 --- a/classes/class_light3d.rst +++ b/classes/class_light3d.rst @@ -841,7 +841,7 @@ If ``true``, reverses the backface culling of the mesh. This can be useful when .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-section-separator diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index 9d09f0f6b..39b5daedc 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -192,7 +192,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedFloat32Array` for more details. diff --git a/classes/class_object.rst b/classes/class_object.rst index 528c71512..f76ba7ab7 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -56,7 +56,7 @@ Lastly, every object can also contain metadata (data about data). :ref:`set_meta Tutorials --------- -- :doc:`Object class introduction <../contributing/development/core_and_modules/object_class>` +- :doc:`Object class introduction <../engine_details/architecture/object_class>` - :doc:`When and how to avoid using nodes for everything <../tutorials/best_practices/node_alternatives>` diff --git a/classes/class_oggpacketsequenceplayback.rst b/classes/class_oggpacketsequenceplayback.rst index 19e4c1b7d..9b7180453 100644 --- a/classes/class_oggpacketsequenceplayback.rst +++ b/classes/class_oggpacketsequenceplayback.rst @@ -14,7 +14,7 @@ OggPacketSequencePlayback .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_omnilight3d.rst b/classes/class_omnilight3d.rst index fe99bd882..e7ce8bc23 100644 --- a/classes/class_omnilight3d.rst +++ b/classes/class_omnilight3d.rst @@ -152,7 +152,7 @@ The light's radius. Note that the effectively lit area may appear to be smaller .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_openxraction.rst b/classes/class_openxraction.rst index b213af5a3..8c2803807 100644 --- a/classes/class_openxraction.rst +++ b/classes/class_openxraction.rst @@ -90,7 +90,7 @@ This action provides a :ref:`Vector2` value and can be bound to e .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! diff --git a/classes/class_packetpeerextension.rst b/classes/class_packetpeerextension.rst index 5d9deea83..f603ef95a 100644 --- a/classes/class_packetpeerextension.rst +++ b/classes/class_packetpeerextension.rst @@ -14,7 +14,7 @@ PacketPeerExtension .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -51,7 +51,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -65,7 +65,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -79,7 +79,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -93,7 +93,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_packetpeerstream.rst b/classes/class_packetpeerstream.rst index a8db41951..779fff94b 100644 --- a/classes/class_packetpeerstream.rst +++ b/classes/class_packetpeerstream.rst @@ -61,7 +61,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -80,7 +80,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_particleprocessmaterial.rst b/classes/class_particleprocessmaterial.rst index ded27bd2b..afd3f5aae 100644 --- a/classes/class_particleprocessmaterial.rst +++ b/classes/class_particleprocessmaterial.rst @@ -481,7 +481,7 @@ Use with :ref:`set_particle_flag()`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -585,7 +585,7 @@ enum **SubEmitterMode**: :ref:`🔗 .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -597,7 +597,7 @@ enum **SubEmitterMode**: :ref:`🔗 .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -609,7 +609,7 @@ enum **SubEmitterMode**: :ref:`🔗 .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -621,7 +621,7 @@ enum **SubEmitterMode**: :ref:`🔗 .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -633,7 +633,7 @@ enum **SubEmitterMode**: :ref:`🔗 .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! diff --git a/classes/class_physicsdirectbodystate2dextension.rst b/classes/class_physicsdirectbodystate2dextension.rst index e892bf33e..9013caa2e 100644 --- a/classes/class_physicsdirectbodystate2dextension.rst +++ b/classes/class_physicsdirectbodystate2dextension.rst @@ -290,7 +290,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.center_of_m .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -304,7 +304,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.center_of_m .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -642,7 +642,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.angular_vel .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -656,7 +656,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.angular_vel .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_physicsdirectbodystate3d.rst b/classes/class_physicsdirectbodystate3d.rst index 8c0510296..94f1adc9b 100644 --- a/classes/class_physicsdirectbodystate3d.rst +++ b/classes/class_physicsdirectbodystate3d.rst @@ -309,7 +309,7 @@ The body's linear velocity in units per second. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_physicsdirectbodystate3dextension.rst b/classes/class_physicsdirectbodystate3dextension.rst index b55449a08..fd7eb85db 100644 --- a/classes/class_physicsdirectbodystate3dextension.rst +++ b/classes/class_physicsdirectbodystate3dextension.rst @@ -150,7 +150,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -164,7 +164,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -178,7 +178,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -192,7 +192,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -206,7 +206,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -220,7 +220,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -234,7 +234,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -248,7 +248,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -262,7 +262,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -276,7 +276,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -290,7 +290,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -304,7 +304,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -318,7 +318,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -332,7 +332,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -346,7 +346,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -360,7 +360,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -374,7 +374,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -388,7 +388,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -402,7 +402,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -416,7 +416,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -430,7 +430,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -444,7 +444,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -458,7 +458,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -472,7 +472,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -486,7 +486,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -500,7 +500,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -514,7 +514,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -528,7 +528,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -542,7 +542,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -556,7 +556,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -570,7 +570,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -584,7 +584,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -598,7 +598,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -612,7 +612,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -626,7 +626,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -640,7 +640,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -654,7 +654,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -668,7 +668,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -682,7 +682,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -696,7 +696,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -710,7 +710,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -724,7 +724,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -738,7 +738,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -752,7 +752,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -766,7 +766,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -780,7 +780,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -794,7 +794,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -808,7 +808,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -822,7 +822,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -836,7 +836,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_physicsdirectspacestate2dextension.rst b/classes/class_physicsdirectspacestate2dextension.rst index b5c62f2c4..c144a5107 100644 --- a/classes/class_physicsdirectspacestate2dextension.rst +++ b/classes/class_physicsdirectspacestate2dextension.rst @@ -64,7 +64,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -78,7 +78,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -92,7 +92,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -106,7 +106,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -120,7 +120,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -134,7 +134,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -148,7 +148,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_physicsdirectspacestate3dextension.rst b/classes/class_physicsdirectspacestate3dextension.rst index 11e39403a..8b2a39cef 100644 --- a/classes/class_physicsdirectspacestate3dextension.rst +++ b/classes/class_physicsdirectspacestate3dextension.rst @@ -66,7 +66,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -80,7 +80,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -94,7 +94,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -108,7 +108,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -122,7 +122,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -136,7 +136,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -150,7 +150,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -164,7 +164,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_physicsserver3d.rst b/classes/class_physicsserver3d.rst index b80a3bfaa..1be72a6b8 100644 --- a/classes/class_physicsserver3d.rst +++ b/classes/class_physicsserver3d.rst @@ -548,7 +548,7 @@ The speed with which the rotation across the axis perpendicular to the hinge get .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -930,7 +930,7 @@ The maximum force that the linear motor can apply while trying to reach the targ .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -942,7 +942,7 @@ The maximum force that the linear motor can apply while trying to reach the targ .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -954,7 +954,7 @@ The maximum force that the linear motor can apply while trying to reach the targ .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1038,7 +1038,7 @@ Maximum acceleration for the motor at the axes. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1050,7 +1050,7 @@ Maximum acceleration for the motor at the axes. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1062,7 +1062,7 @@ Maximum acceleration for the motor at the axes. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1108,7 +1108,7 @@ If set, rotational motion is possible. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1120,7 +1120,7 @@ If set, rotational motion is possible. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1788,7 +1788,7 @@ enum **BodyAxis**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1800,7 +1800,7 @@ enum **BodyAxis**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1812,7 +1812,7 @@ enum **BodyAxis**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1824,7 +1824,7 @@ enum **BodyAxis**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1836,7 +1836,7 @@ enum **BodyAxis**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1848,7 +1848,7 @@ enum **BodyAxis**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2111,7 +2111,7 @@ By counting (or keeping track of) the shapes that enter and exit, it can be dete .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2161,7 +2161,7 @@ Substitutes a given area shape by another. The old shape is selected by its inde .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2583,7 +2583,7 @@ Returns a body state. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2659,7 +2659,7 @@ Restores the default inertia and center of mass based on shapes to cancel any cu .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2859,7 +2859,7 @@ Substitutes a given body shape by another. The old shape is selected by its inde .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2939,7 +2939,7 @@ Returns ``true`` if a collision would result from moving along a motion vector f .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2953,7 +2953,7 @@ Returns ``true`` if a collision would result from moving along a motion vector f .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2967,7 +2967,7 @@ Returns ``true`` if a collision would result from moving along a motion vector f .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3005,7 +3005,7 @@ Sets a cone twist joint parameter. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3019,7 +3019,7 @@ Sets a cone twist joint parameter. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3033,7 +3033,7 @@ Sets a cone twist joint parameter. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3119,7 +3119,7 @@ Returns the value of a physics engine state specified by ``process_info``. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3181,7 +3181,7 @@ Sets a hinge joint parameter. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3195,7 +3195,7 @@ Sets a hinge joint parameter. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3257,7 +3257,7 @@ Returns whether the bodies attached to the :ref:`Joint3D` will co .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3283,7 +3283,7 @@ Make the joint a generic six degrees of freedom (6DOF) joint. Use :ref:`generic_ .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3297,7 +3297,7 @@ Make the joint a generic six degrees of freedom (6DOF) joint. Use :ref:`generic_ .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3311,7 +3311,7 @@ Make the joint a generic six degrees of freedom (6DOF) joint. Use :ref:`generic_ .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3409,7 +3409,7 @@ Sets a pin joint parameter. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -4075,7 +4075,7 @@ Sets the value for a space parameter. A list of available parameters is on the : .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -4089,7 +4089,7 @@ Sets the value for a space parameter. A list of available parameters is on the : .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_physicsserver3dextension.rst b/classes/class_physicsserver3dextension.rst index 2c4e56b88..30e4265ff 100644 --- a/classes/class_physicsserver3dextension.rst +++ b/classes/class_physicsserver3dextension.rst @@ -442,7 +442,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -456,7 +456,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -470,7 +470,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -484,7 +484,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -498,7 +498,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -512,7 +512,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -526,7 +526,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -540,7 +540,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -554,7 +554,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -568,7 +568,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -582,7 +582,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -596,7 +596,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -610,7 +610,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -624,7 +624,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -638,7 +638,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -652,7 +652,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -666,7 +666,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -680,7 +680,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -694,7 +694,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -708,7 +708,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -722,7 +722,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -736,7 +736,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -750,7 +750,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -764,7 +764,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -778,7 +778,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -792,7 +792,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -806,7 +806,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -820,7 +820,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -834,7 +834,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -848,7 +848,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -862,7 +862,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -876,7 +876,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -890,7 +890,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -904,7 +904,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -918,7 +918,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -932,7 +932,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -946,7 +946,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -960,7 +960,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -974,7 +974,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -988,7 +988,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1002,7 +1002,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1016,7 +1016,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1030,7 +1030,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1044,7 +1044,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1058,7 +1058,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1072,7 +1072,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1086,7 +1086,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1100,7 +1100,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1114,7 +1114,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1128,7 +1128,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1142,7 +1142,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1156,7 +1156,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1170,7 +1170,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1184,7 +1184,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1198,7 +1198,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1212,7 +1212,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1226,7 +1226,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1240,7 +1240,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1254,7 +1254,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1268,7 +1268,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1282,7 +1282,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1296,7 +1296,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1310,7 +1310,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1324,7 +1324,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1338,7 +1338,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1352,7 +1352,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1366,7 +1366,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1380,7 +1380,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1394,7 +1394,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1408,7 +1408,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1422,7 +1422,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1436,7 +1436,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1450,7 +1450,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1464,7 +1464,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1478,7 +1478,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1492,7 +1492,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1506,7 +1506,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1520,7 +1520,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1534,7 +1534,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1548,7 +1548,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1562,7 +1562,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1576,7 +1576,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1590,7 +1590,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1604,7 +1604,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1618,7 +1618,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1632,7 +1632,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1646,7 +1646,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1660,7 +1660,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1674,7 +1674,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1688,7 +1688,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1702,7 +1702,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1716,7 +1716,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1730,7 +1730,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1744,7 +1744,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1758,7 +1758,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1772,7 +1772,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1786,7 +1786,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1800,7 +1800,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1814,7 +1814,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1828,7 +1828,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1842,7 +1842,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1856,7 +1856,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1870,7 +1870,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1884,7 +1884,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1898,7 +1898,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1912,7 +1912,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1926,7 +1926,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1940,7 +1940,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1954,7 +1954,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1968,7 +1968,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1982,7 +1982,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1996,7 +1996,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2010,7 +2010,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2024,7 +2024,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2038,7 +2038,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2052,7 +2052,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2066,7 +2066,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2080,7 +2080,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2094,7 +2094,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2108,7 +2108,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2122,7 +2122,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2136,7 +2136,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2150,7 +2150,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2164,7 +2164,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2178,7 +2178,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2192,7 +2192,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2206,7 +2206,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2220,7 +2220,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2234,7 +2234,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2248,7 +2248,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2262,7 +2262,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2276,7 +2276,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2290,7 +2290,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2304,7 +2304,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2318,7 +2318,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2332,7 +2332,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2346,7 +2346,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2360,7 +2360,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2374,7 +2374,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2388,7 +2388,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2402,7 +2402,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2416,7 +2416,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2430,7 +2430,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2444,7 +2444,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2458,7 +2458,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2472,7 +2472,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2486,7 +2486,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2500,7 +2500,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2514,7 +2514,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2528,7 +2528,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2542,7 +2542,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2556,7 +2556,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2570,7 +2570,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2584,7 +2584,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2598,7 +2598,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2612,7 +2612,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2626,7 +2626,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2640,7 +2640,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2654,7 +2654,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2668,7 +2668,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2682,7 +2682,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2696,7 +2696,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2710,7 +2710,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2724,7 +2724,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2738,7 +2738,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2752,7 +2752,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2766,7 +2766,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2780,7 +2780,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2794,7 +2794,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2808,7 +2808,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2822,7 +2822,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2836,7 +2836,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2850,7 +2850,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2864,7 +2864,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2878,7 +2878,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2892,7 +2892,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2906,7 +2906,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2920,7 +2920,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2934,7 +2934,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2948,7 +2948,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2962,7 +2962,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2976,7 +2976,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2990,7 +2990,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3004,7 +3004,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3018,7 +3018,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3032,7 +3032,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3046,7 +3046,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3060,7 +3060,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3074,7 +3074,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3088,7 +3088,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3102,7 +3102,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3116,7 +3116,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3130,7 +3130,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3144,7 +3144,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3158,7 +3158,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3172,7 +3172,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index 35a781f02..bc552ecc1 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -14,7 +14,7 @@ PolygonPathFinder .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -59,7 +59,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -73,7 +73,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -87,7 +87,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -101,7 +101,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -115,7 +115,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -169,7 +169,7 @@ Returns ``true`` if ``point`` falls inside the polygon area. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_portablecompressedtexture2d.rst b/classes/class_portablecompressedtexture2d.rst index fc9681e10..a44eb2af8 100644 --- a/classes/class_portablecompressedtexture2d.rst +++ b/classes/class_portablecompressedtexture2d.rst @@ -90,7 +90,7 @@ enum **CompressionMode**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -102,7 +102,7 @@ enum **CompressionMode**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -114,7 +114,7 @@ enum **CompressionMode**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -126,7 +126,7 @@ enum **CompressionMode**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -138,7 +138,7 @@ enum **CompressionMode**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -150,7 +150,7 @@ enum **CompressionMode**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -162,7 +162,7 @@ enum **CompressionMode**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index a52f6accc..fff1f8346 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -4860,7 +4860,7 @@ On desktop platforms, overrides the game's initial window width. See also :ref:` .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -5026,7 +5026,7 @@ The maximum width to use when importing textures as an atlas. The value will be .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -5296,7 +5296,7 @@ Search path for project-specific script templates. Godot will search for script .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -5310,7 +5310,7 @@ Search path for project-specific script templates. Godot will search for script .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -12398,7 +12398,7 @@ The minimum number of instances that must be present in a scene to enable cullin .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -13100,7 +13100,7 @@ Scales the 3D render buffer based on the viewport size uses an image filter spec .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -13126,7 +13126,7 @@ Enable the shader cache, which stores compiled shaders to disk to prevent stutte .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -13140,7 +13140,7 @@ Enable the shader cache, which stores compiled shaders to disk to prevent stutte .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -13154,7 +13154,7 @@ Enable the shader cache, which stores compiled shaders to disk to prevent stutte .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_renderingdevice.rst b/classes/class_renderingdevice.rst index 521d017e9..a6f87ad6d 100644 --- a/classes/class_renderingdevice.rst +++ b/classes/class_renderingdevice.rst @@ -2385,7 +2385,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2397,7 +2397,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2409,7 +2409,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2421,7 +2421,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2433,7 +2433,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2445,7 +2445,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2457,7 +2457,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2469,7 +2469,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2481,7 +2481,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2493,7 +2493,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2505,7 +2505,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2517,7 +2517,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2529,7 +2529,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2541,7 +2541,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -3185,7 +3185,7 @@ flags **StorageBufferUsage**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -4074,7 +4074,7 @@ Allows dynamically changing the depth bias. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -4086,7 +4086,7 @@ Allows dynamically changing the depth bias. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -4098,7 +4098,7 @@ Allows dynamically changing the depth bias. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -4110,7 +4110,7 @@ Allows dynamically changing the depth bias. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -4122,7 +4122,7 @@ Allows dynamically changing the depth bias. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index bbb975c9a..e5bda724c 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -2196,7 +2196,7 @@ Blurs the edges of the shadow. Can be used to hide pixel artifacts in low resolu .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2650,7 +2650,7 @@ enum **ParticlesTransformAlign**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2662,7 +2662,7 @@ enum **ParticlesTransformAlign**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2674,7 +2674,7 @@ enum **ParticlesTransformAlign**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2686,7 +2686,7 @@ enum **ParticlesTransformAlign**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2750,7 +2750,7 @@ enum **ParticlesCollisionType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2762,7 +2762,7 @@ enum **ParticlesCollisionType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2774,7 +2774,7 @@ enum **ParticlesCollisionType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2786,7 +2786,7 @@ enum **ParticlesCollisionType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2798,7 +2798,7 @@ enum **ParticlesCollisionType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2810,7 +2810,7 @@ enum **ParticlesCollisionType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2822,7 +2822,7 @@ enum **ParticlesCollisionType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2844,7 +2844,7 @@ enum **ParticlesCollisionHeightfieldResolution**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2856,7 +2856,7 @@ enum **ParticlesCollisionHeightfieldResolution**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2868,7 +2868,7 @@ enum **ParticlesCollisionHeightfieldResolution**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2880,7 +2880,7 @@ enum **ParticlesCollisionHeightfieldResolution**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2892,7 +2892,7 @@ enum **ParticlesCollisionHeightfieldResolution**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2904,7 +2904,7 @@ enum **ParticlesCollisionHeightfieldResolution**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -4032,7 +4032,7 @@ The callback is called after our transparent rendering pass, but before any buil .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -5342,7 +5342,7 @@ Parent is used for clipping child, but parent is also drawn underneath child as .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -6041,7 +6041,7 @@ The number of custom data arrays available (:ref:`ARRAY_CUSTOM0`! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -6053,7 +6053,7 @@ The number of custom data arrays available (:ref:`ARRAY_CUSTOM0`! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -6065,7 +6065,7 @@ The number of custom data arrays available (:ref:`ARRAY_CUSTOM0`! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -6077,7 +6077,7 @@ The number of custom data arrays available (:ref:`ARRAY_CUSTOM0`! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -6089,7 +6089,7 @@ The number of custom data arrays available (:ref:`ARRAY_CUSTOM0`! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -7088,7 +7088,7 @@ This is useful when moving an occluder to a new location, to give an instantaneo .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -7472,7 +7472,7 @@ Sets the shape of the occluder polygon. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -8182,7 +8182,7 @@ Sets the variables to be used with the screen-space reflections (SSR) post-proce .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9316,7 +9316,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9330,7 +9330,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9344,7 +9344,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9358,7 +9358,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9384,7 +9384,7 @@ Used to inform the renderer what exposure normalization value was used while bak .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9398,7 +9398,7 @@ Used to inform the renderer what exposure normalization value was used while bak .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9412,7 +9412,7 @@ Used to inform the renderer what exposure normalization value was used while bak .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9426,7 +9426,7 @@ Used to inform the renderer what exposure normalization value was used while bak .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9552,7 +9552,7 @@ Sets a shader material's shader. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9566,7 +9566,7 @@ Sets a shader material's shader. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9610,7 +9610,7 @@ To place in a scene, attach this mesh to an instance using :ref:`instance_set_ba .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9660,7 +9660,7 @@ Returns a mesh's custom aabb. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9710,7 +9710,7 @@ Sets a mesh's custom aabb. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9856,7 +9856,7 @@ Sets a mesh's surface's material. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9882,7 +9882,7 @@ Updates the index buffer of the mesh surface with the given ``data``. The expect .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9896,7 +9896,7 @@ Updates the index buffer of the mesh surface with the given ``data``. The expect .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9910,7 +9910,7 @@ Updates the index buffer of the mesh surface with the given ``data``. The expect .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -10598,7 +10598,7 @@ Sets the amount ratio for particles to be emitted. Equivalent to :ref:`GPUPartic .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -10744,7 +10744,7 @@ Sets the value that informs a :ref:`ParticleProcessMaterial`! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -10844,7 +10844,7 @@ Sets the speed scale of the particle system. Equivalent to :ref:`GPUParticles3D. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -10858,7 +10858,7 @@ Sets the speed scale of the particle system. Equivalent to :ref:`GPUParticles3D. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -10884,7 +10884,7 @@ If ``enable`` is ``true``, enables trails for the ``particles`` with the specifi .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -11350,7 +11350,7 @@ Sets the path hint for the specified shader. This should generally match the :re .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -11438,7 +11438,7 @@ Returns the number of bones allocated for this skeleton. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -11762,7 +11762,7 @@ Returns the internal graphics handle for this texture object. For use when commu .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -11840,7 +11840,7 @@ Replaces ``texture``'s texture data by the texture specified by the ``by_texture .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -11854,7 +11854,7 @@ Replaces ``texture``'s texture data by the texture specified by the ``by_texture .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -11868,7 +11868,7 @@ Replaces ``texture``'s texture data by the texture specified by the ``by_texture .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -12601,7 +12601,7 @@ To place in a scene, attach this notifier to an instance using :ref:`instance_se .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -12615,7 +12615,7 @@ To place in a scene, attach this notifier to an instance using :ref:`instance_se .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -12629,7 +12629,7 @@ To place in a scene, attach this notifier to an instance using :ref:`instance_se .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -12659,7 +12659,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -12673,7 +12673,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -12687,7 +12687,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -12701,7 +12701,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -12715,7 +12715,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -12729,7 +12729,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_resourceformatloader.rst b/classes/class_resourceformatloader.rst index d505b9b15..800532ba9 100644 --- a/classes/class_resourceformatloader.rst +++ b/classes/class_resourceformatloader.rst @@ -129,7 +129,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -143,7 +143,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_resourceimportertexture.rst b/classes/class_resourceimportertexture.rst index f74d61be4..3b717a421 100644 --- a/classes/class_resourceimportertexture.rst +++ b/classes/class_resourceimportertexture.rst @@ -249,7 +249,7 @@ Changing this import option only has an effect if a texture is detected as being :ref:`bool` **editor/convert_colors_with_editor_theme** = ``false`` :ref:`🔗` -If ``true``, converts the imported image's colors to match :ref:`EditorSettings.interface/theme/icon_and_font_color`. This assumes the image uses the exact same colors as :doc:`Godot's own color palette for editor icons <../contributing/development/editor/creating_icons>`, with the source file designed for a dark editor theme. This should be enabled for editor plugin icons and custom class icons, but should be left disabled otherwise. +If ``true``, converts the imported image's colors to match :ref:`EditorSettings.interface/theme/icon_and_font_color`. This assumes the image uses the exact same colors as :doc:`Godot's own color palette for editor icons <../engine_details/editor/creating_icons>`, with the source file designed for a dark editor theme. This should be enabled for editor plugin icons and custom class icons, but should be left disabled otherwise. \ **Note:** Only available for SVG images. diff --git a/classes/class_scriptextension.rst b/classes/class_scriptextension.rst index 27943ec9a..fd97468bd 100644 --- a/classes/class_scriptextension.rst +++ b/classes/class_scriptextension.rst @@ -14,7 +14,7 @@ ScriptExtension .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -117,7 +117,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -131,7 +131,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -145,7 +145,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -159,7 +159,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -173,7 +173,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -187,7 +187,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -201,7 +201,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -215,7 +215,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -229,7 +229,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -243,7 +243,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -257,7 +257,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -271,7 +271,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -285,7 +285,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -299,7 +299,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -313,7 +313,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -339,7 +339,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -353,7 +353,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -367,7 +367,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -381,7 +381,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -395,7 +395,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -409,7 +409,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -423,7 +423,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -437,7 +437,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -451,7 +451,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -465,7 +465,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -479,7 +479,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -493,7 +493,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -519,7 +519,7 @@ Returns ``true`` if the script is an abstract script. Abstract scripts cannot be .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -533,7 +533,7 @@ Returns ``true`` if the script is an abstract script. Abstract scripts cannot be .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -547,7 +547,7 @@ Returns ``true`` if the script is an abstract script. Abstract scripts cannot be .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -561,7 +561,7 @@ Returns ``true`` if the script is an abstract script. Abstract scripts cannot be .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -575,7 +575,7 @@ Returns ``true`` if the script is an abstract script. Abstract scripts cannot be .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -589,7 +589,7 @@ Returns ``true`` if the script is an abstract script. Abstract scripts cannot be .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -603,7 +603,7 @@ Returns ``true`` if the script is an abstract script. Abstract scripts cannot be .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -617,7 +617,7 @@ Returns ``true`` if the script is an abstract script. Abstract scripts cannot be .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_scriptlanguage.rst b/classes/class_scriptlanguage.rst index b3a6d1a5f..889b83752 100644 --- a/classes/class_scriptlanguage.rst +++ b/classes/class_scriptlanguage.rst @@ -16,7 +16,7 @@ ScriptLanguage .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-section-separator @@ -41,7 +41,7 @@ enum **ScriptNameCasing**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -53,7 +53,7 @@ enum **ScriptNameCasing**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -65,7 +65,7 @@ enum **ScriptNameCasing**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -77,7 +77,7 @@ enum **ScriptNameCasing**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -89,7 +89,7 @@ enum **ScriptNameCasing**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! diff --git a/classes/class_scriptlanguageextension.rst b/classes/class_scriptlanguageextension.rst index 45bc97540..45b0c326d 100644 --- a/classes/class_scriptlanguageextension.rst +++ b/classes/class_scriptlanguageextension.rst @@ -14,7 +14,7 @@ ScriptLanguageExtension .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -169,7 +169,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -181,7 +181,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -193,7 +193,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -205,7 +205,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -217,7 +217,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -229,7 +229,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -241,7 +241,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -263,7 +263,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -275,7 +275,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -287,7 +287,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -299,7 +299,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -363,7 +363,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -375,7 +375,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -387,7 +387,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -399,7 +399,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -411,7 +411,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -423,7 +423,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -435,7 +435,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -447,7 +447,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -459,7 +459,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -471,7 +471,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -483,7 +483,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -504,7 +504,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -518,7 +518,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -532,7 +532,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -546,7 +546,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -560,7 +560,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -574,7 +574,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -588,7 +588,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -602,7 +602,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -616,7 +616,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -630,7 +630,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -644,7 +644,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -658,7 +658,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -672,7 +672,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -686,7 +686,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -700,7 +700,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -714,7 +714,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -740,7 +740,7 @@ Returns the source associated with a given debug stack position. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -766,7 +766,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -780,7 +780,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -794,7 +794,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -808,7 +808,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -822,7 +822,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -836,7 +836,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -850,7 +850,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -864,7 +864,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -878,7 +878,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -892,7 +892,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -906,7 +906,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -920,7 +920,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -934,7 +934,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -948,7 +948,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -962,7 +962,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -976,7 +976,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1002,7 +1002,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1016,7 +1016,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1030,7 +1030,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1044,7 +1044,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1058,7 +1058,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1072,7 +1072,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1086,7 +1086,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1100,7 +1100,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1114,7 +1114,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1128,7 +1128,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1142,7 +1142,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1156,7 +1156,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1170,7 +1170,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1184,7 +1184,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1198,7 +1198,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1212,7 +1212,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1226,7 +1226,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1240,7 +1240,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1254,7 +1254,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1268,7 +1268,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1282,7 +1282,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1296,7 +1296,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1310,7 +1310,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1324,7 +1324,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_skeleton3d.rst b/classes/class_skeleton3d.rst index ee2d04dad..3aacfcb18 100644 --- a/classes/class_skeleton3d.rst +++ b/classes/class_skeleton3d.rst @@ -443,7 +443,7 @@ Removes the global pose override on all bones in the skeleton. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_skin.rst b/classes/class_skin.rst index 4fd135dd4..33cc1020c 100644 --- a/classes/class_skin.rst +++ b/classes/class_skin.rst @@ -14,7 +14,7 @@ Skin .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -65,7 +65,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -79,7 +79,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -93,7 +93,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -107,7 +107,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -121,7 +121,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -135,7 +135,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -149,7 +149,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -163,7 +163,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -177,7 +177,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -191,7 +191,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -205,7 +205,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_streampeerextension.rst b/classes/class_streampeerextension.rst index 6a5ce4e81..715aad48f 100644 --- a/classes/class_streampeerextension.rst +++ b/classes/class_streampeerextension.rst @@ -14,7 +14,7 @@ StreamPeerExtension .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -53,7 +53,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -67,7 +67,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -81,7 +81,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -95,7 +95,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -109,7 +109,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index 9923046dd..681891a1b 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -181,7 +181,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -195,7 +195,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -221,7 +221,7 @@ Virtual method to be implemented by the user. Returns a custom minimum size that .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_textserverextension.rst b/classes/class_textserverextension.rst index ee1ca4fcc..70a6bab2b 100644 --- a/classes/class_textserverextension.rst +++ b/classes/class_textserverextension.rst @@ -2232,7 +2232,7 @@ Returns ``true`` if ``string`` is a valid identifier. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_variant.rst b/classes/class_variant.rst index 1fe674b41..cd458a56c 100644 --- a/classes/class_variant.rst +++ b/classes/class_variant.rst @@ -130,7 +130,7 @@ Modifications to a container will modify all references to it. A :ref:`Mutex` +- :doc:`Variant class introduction <../engine_details/architecture/variant_class>` .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_visualinstance3d.rst b/classes/class_visualinstance3d.rst index 38a978f91..734e22cb0 100644 --- a/classes/class_visualinstance3d.rst +++ b/classes/class_visualinstance3d.rst @@ -146,7 +146,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_visualshadernoderemap.rst b/classes/class_visualshadernoderemap.rst index fb49b50f5..3b6e32422 100644 --- a/classes/class_visualshadernoderemap.rst +++ b/classes/class_visualshadernoderemap.rst @@ -134,7 +134,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_voxelgidata.rst b/classes/class_voxelgidata.rst index 31c711ebc..cc802f912 100644 --- a/classes/class_voxelgidata.rst +++ b/classes/class_voxelgidata.rst @@ -219,7 +219,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -247,7 +247,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -261,7 +261,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -275,7 +275,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -289,7 +289,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -303,7 +303,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_webrtcdatachannel.rst b/classes/class_webrtcdatachannel.rst index 3ff003570..d06e52d05 100644 --- a/classes/class_webrtcdatachannel.rst +++ b/classes/class_webrtcdatachannel.rst @@ -16,7 +16,7 @@ WebRTCDataChannel .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group diff --git a/classes/class_webrtcdatachannelextension.rst b/classes/class_webrtcdatachannelextension.rst index 5e3ee61dd..0f37db1b5 100644 --- a/classes/class_webrtcdatachannelextension.rst +++ b/classes/class_webrtcdatachannelextension.rst @@ -14,7 +14,7 @@ WebRTCDataChannelExtension .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -79,7 +79,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -93,7 +93,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -107,7 +107,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -121,7 +121,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -135,7 +135,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -149,7 +149,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -163,7 +163,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -177,7 +177,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -191,7 +191,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -205,7 +205,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -219,7 +219,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -233,7 +233,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -247,7 +247,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -261,7 +261,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -275,7 +275,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -289,7 +289,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -303,7 +303,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -317,7 +317,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_webrtcpeerconnectionextension.rst b/classes/class_webrtcpeerconnectionextension.rst index b10ab6684..b4077195a 100644 --- a/classes/class_webrtcpeerconnectionextension.rst +++ b/classes/class_webrtcpeerconnectionextension.rst @@ -14,7 +14,7 @@ WebRTCPeerConnectionExtension .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -65,7 +65,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -79,7 +79,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -93,7 +93,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -107,7 +107,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -121,7 +121,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -135,7 +135,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -149,7 +149,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -163,7 +163,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -177,7 +177,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -191,7 +191,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -205,7 +205,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_xrinterfaceextension.rst b/classes/class_xrinterfaceextension.rst index 6a6483a13..ba5a72491 100644 --- a/classes/class_xrinterfaceextension.rst +++ b/classes/class_xrinterfaceextension.rst @@ -357,7 +357,7 @@ Returns the number of views this interface requires, 1 for mono, 2 for stereosco .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -527,7 +527,7 @@ Blits our render results to screen optionally applying lens distortion. This can .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -541,7 +541,7 @@ Blits our render results to screen optionally applying lens distortion. This can .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -567,7 +567,7 @@ Returns a valid :ref:`RID` for a texture to which we should render th .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/contributing/development/best_practices_for_engine_contributors.rst b/contributing/development/best_practices_for_engine_contributors.rst deleted file mode 100644 index 751dfdb16..000000000 --- a/contributing/development/best_practices_for_engine_contributors.rst +++ /dev/null @@ -1,242 +0,0 @@ -.. _doc_best_practices_for_engine_contributors: - -Best practices for engine contributors -====================================== - -Introduction ------------- - -Godot has a large amount of users who have the ability to contribute because the -project itself is aimed mainly at users who can code. That being said, not all -of them have the same level of experience working in large projects or in -software engineering, which can lead to common misunderstandings and bad -practices during the process of contributing code to the project. - -Language --------- - -The scope of this document is to be a list of best practices for contributors to -follow, as well as to create a language they can use to refer to common -situations that arise in the process of submitting their contributions. - -While a generalized list of software development best practices might be useful, -we'll focus on the situations that are most common in our project. - -Contributions are most of the time categorized as bug fixes, enhancements or new -features. To abstract this idea, we will call them *Solutions*, because they -always seek to solve something that can be described as a *Problem*. - -Best Practices --------------- - -#1: The problem always comes first -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Many contributors are extremely creative and just enjoy the process of designing -abstract data structures, creating nice user interfaces, or simply love -programming. Whatever the case may be, they come up with cool ideas, which may -or may not solve real problems. - -.. image:: img/best_practices1.png - -These are usually called *solutions in search of a problem*. In an ideal world, -they would not be harmful but, in reality, code takes time to write, takes up -space and requires maintenance once it exists. Avoiding the addition of anything -unnecessary is always considered a good practice in software development. - -#2: To solve the problem, it has to exist in the first place -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This is a variation of the previous practice. Adding anything unnecessary is not -a good idea, but what constitutes what is necessary and what isn't? - -.. image:: img/best_practices2.png - -The answer to this question is that the problem needs to *exist* before it can -be actually solved. It must not be speculation or a belief. The user must be -using the software as intended to create something they *need*. In this process, -the user may stumble upon a problem that requires a solution to proceed, or in -order to achieve greater productivity. In this case, *a solution is needed*. - -Believing that problems may arise in the future and that the software needs to -be ready to solve them by the time they appear is called *"Future proofing"* and -it's characterized by lines of thought such as: - -- I think it would be useful for users to... -- I think users will eventually need to... - -This is generally considered a bad habit because trying to solve problems that -*don't actually exist* in the present will often lead to code that will be -written but never used, or that is considerably more complex to use and maintain -than it needs to be. - -#3: The problem has to be complex or frequent -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Software is designed to solve problems, but we can't expect it to solve *every -problem that exists under the sun*. As a game engine, Godot will help you make -games better and faster, but it won't make an *entire game* for you. A line must -be drawn somewhere. - -.. image:: img/best_practices3.png - -Whether a problem is worth solving is determined by the effort that is required -to work around it. The required effort depends on: - -- The complexity of the problem -- The frequency the problem - -If the problem is *too complex* for most users to solve, then the software -should offer a ready-made solution for it. Likewise, if the problem is easy for -the user to work around, offering such a solution is unnecessary. - -The exception, however, is when the user encounters a problem *frequently -enough* that having to do the simple solution every time becomes an annoyance. -In this case, the software should offer a solution to simplify the use case. - -It's usually easy to tell if a problem is complex or frequent, but it can be -difficult. This is why discussing with other developers (next point) is always -advised. - -#4: The solution must be discussed with others -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Often, users will be immersed in their own projects when they stumble upon -problems. These users will naturally try to solve the problem from their -perspective, thinking only about their own use case. As a result, user proposed -solutions don't always contemplate all use cases and are often biased towards -the user's own requirements. - -.. image:: img/best_practices4.png - -For developers, the perspective is different. They may find the user's problem -too unique to justify a solution (instead of a workaround), or they might -suggest a partial (usually simpler or lower level) solution that applies to a -wider range of known problems and leave the rest of the solution up to the -user. - -In any case, before attempting to contribute, it is important to discuss the -actual problems with the other developers or contributors, so a better agreement -on implementation can be reached. - -The only exception is when an area of code has a clear agreed upon owner, who -talks to users directly and has the most knowledge to implement a solution -directly. - -Also, Godot's philosophy is to favor ease of use and maintenance over absolute -performance. Performance optimizations will be considered, but they may not -be accepted if they make something too difficult to use or if they add too much -complexity to the codebase. - -#5: To each problem, its own solution -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -For programmers, it is always a most enjoyable challenge to find the most -optimal solutions to problems. It is possible to go overboard, though. -Sometimes, contributors will try to come up with solutions that solve as many -problems as possible. - -The situation will often take a turn for the worse when, in order to make this -solution appear even more fantastic and flexible, the pure speculation-based -problems (as described in #2) also make their appearance on stage. - -.. image:: img/best_practices5.png - -The main problem is that, in reality, it rarely works this way. Most of the -time, writing an individual solution to each problem results in code that -is simpler and more maintainable. - -Additionally, solutions that target individual problems are better for the -users. Targeted solutions allow users find something that does exactly what they -need, without having to learn a more complex system they will only need for simple -tasks. - -Big and flexible solutions also have an additional drawback which is that, over -time, they are rarely flexible enough for all users. Users end up requesting -more and more functionality which ends up making the API and codebase -more and more complex. - -#6: Cater to common use cases, leave the door open for the rare ones -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This is a continuation of the previous point, which further explains why this -way of thinking and designing software is preferred. - -As mentioned before (in point #2), it is very difficult for us (as human beings -who design software) to actually understand all future user needs. Trying to -write very flexible structures that cater to many use cases at once is often a -mistake. - -We may come up with something we believe is brilliant, but later find out that -users will never even use half of it or that they require features that don't -quite fit into our original design, forcing us to either throw it away -or make it even more complex. - -The question is then, how do we design software that both allows users to do -*what we know they need to do* now and allows them to do *what we don't yet know -they'll need to do* in the future? - -.. image:: img/best_practices6.png - -The answer to this question is that, to ensure users still can do what they want -to do, we need to give them access to a *low-level API* that they can use to -achieve what they want, even if it's more work for them because it means -reimplementing some logic that already exists. - -In real-life scenarios, these use cases will be at most rare and uncommon -anyway, so it makes sense a custom solution needs to be written. This is why -it's important to still provide users the basic building blocks to do it. - -#7: Prefer local solutions -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -When looking for a solution to a problem, be it implementing a new feature or -fixing a bug, sometimes the easiest path is to add data or a new function in the -core layers of code. - -The main problem here is, adding something to the core layers that will only be -used from a single location far away will not only make the code more difficult -to follow (split in two), but also make the core API larger, more complex, more -difficult to understand in general. - -This is bad, because readability and cleanness of core APIs is always of extreme -importance given how much code relies on it, and because it's key for new -contributors as a starting point to learning the codebase. - - -.. image:: img/best_practices7.png - - -A common reason for wanting to do this is that it's usually less code to simply -add a hack in the core layers. - -Doing so is not advised. Generally, the code for a solution should be closer to -where the problem originates, even if it involves additional, duplicated, more -complex, or less efficient code. More creativity might be needed, but this path -is always the advised one. - -#8: Don't use complex canned solutions for simple problems -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Not every problem has a simple solution and, many times, the right choice is to -use a third-party library to solve the problem. - -As Godot requires to be shipped in a large amount of platforms, we can't -link libraries dynamically. Instead, we bundle them in our source tree. - -.. image:: img/best_practices8.png - -As a result, we are very picky with what goes in, and we tend to prefer smaller -libraries (single header ones are our favorite). We will only bundle something -larger if there is no other choice. - -.. _doc_best_practices_for_engine_contributors_license_compliance: - -Libraries must use a permissive enough license to be included into Godot. -Some examples of acceptable licenses are Apache 2.0, BSD, MIT, ISC, and MPL 2.0. -In particular, we cannot accept libraries licensed under the GPL or LGPL since -these licenses effectively disallow static linking in proprietary software -(which Godot is distributed as in most exported projects). This requirement also -applies to the editor, since we may want to run it on iOS in the long term. -Since iOS doesn't support dynamic linking, static linking is the only option on -that platform. diff --git a/contributing/development/code_style_guidelines.rst b/contributing/development/code_style_guidelines.rst deleted file mode 100644 index f147f905a..000000000 --- a/contributing/development/code_style_guidelines.rst +++ /dev/null @@ -1,393 +0,0 @@ -.. _doc_code_style_guidelines: - -Code style guidelines -===================== - -.. highlight:: shell - -When contributing to Godot's source code, you will be expected to follow the -style guidelines outlined below. Some of them are checked via the Continuous -Integration process and reviewers will ask you to fix potential issues, so -best setup your system as outlined below to ensure all your commits follow the -guidelines. - -C++ and Objective-C -------------------- - -There are no written guidelines, but the code style agreed upon by the -developers is enforced via the `clang-format `__ -code beautifier, which takes care for you of all our conventions. -To name a few: - -- Indentation and alignment are both tab based (respectively one and two tabs) -- One space around math and assignments operators as well as after commas -- Pointer and reference operators are affixed to the variable identifier, not - to the type name -- See further down regarding header includes - -The rules used by clang-format are outlined in the -`.clang-format `__ -file of the Godot repository. - -As long as you ensure that your style matches the surrounding code and that you're -not introducing trailing whitespace or space-based indentation, you should be -fine. If you plan to contribute regularly, however, we strongly advise that you -set up clang-format locally to check and automatically fix all your commits. - -.. warning:: Godot's code style should *not* be applied to third-party code, - i.e. code that is included in Godot's source tree, but was not written - specifically for our project. Such code usually comes from - different upstream projects with their own style guides (or lack - thereof), and don't want to introduce differences that would make - syncing with upstream repositories harder. - - Third-party code is usually included in the ``thirdparty/`` folder - and can thus easily be excluded from formatting scripts. For the - rare cases where a third-party code snippet needs to be included - directly within a Godot file, you can use - ``/* clang-format off */`` and ``/* clang-format on */`` to tell - clang-format to ignore a chunk of code. - -.. seealso:: - - These guidelines only cover code formatting. See :ref:`doc_cpp_usage_guidelines` - for a list of language features that are permitted in pull requests. - - -Using clang-format locally -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You need to use **clang-format 17** to be compatible with Godot's format. Later versions might -be suitable, but previous versions may not support all used options, or format -some things differently, leading to style issues in pull requests. - -.. _doc_code_style_guidelines_pre_commit_hook: - -Pre-commit hook -^^^^^^^^^^^^^^^ - -For ease of use, we provide hooks for Git with the `pre-commit `__ -Python framework that will run clang-format automatically on all your commits with the -correct version of clang-format. -To set up: - -:: - - pip install pre-commit - pre-commit install - - -You can also run the hook manually with ``pre-commit run``. - -.. note:: - - Previously, we supplied a hook in the folder ``misc/hooks``. If you copied the - script manually, these hooks should still work, but symlinks will be broken. - If you are using the new system, run ``rm .git/hooks/*`` to remove the old hooks - that are no longer needed. - - -Installation -^^^^^^^^^^^^ - -Here's how to install clang-format: - -- Linux: It will usually be available out-of-the-box with the clang toolchain - packaged by your distribution. If your distro version is not the required one, - you can download a pre-compiled version from the - `LLVM website `__, or if you are on - a Debian derivative, use the `upstream repos `__. -- macOS and Windows: You can download precompiled binaries from the - `LLVM website `__. You may need to add - the path to the binary's folder to your system's ``PATH`` environment - variable to be able to call clang-format out of the box. - -You then have different possibilities to apply clang-format to your changes: - -Manual usage -^^^^^^^^^^^^ - -You can apply clang-format manually for one or more files with the following -command: - -:: - - clang-format -i - -- ``-i`` means that the changes should be written directly to the file (by - default clang-format would only output the fixed version to the terminal). -- The path can point to several files, either one after the other or using - wildcards like in a typical Unix shell. Be careful when globbing so that - you don't run clang-format on compiled objects (.o and .a files) that are - in Godot's tree. So better use ``core/*.{cpp,h}`` than ``core/*``. - - -IDE plugin -^^^^^^^^^^ - -Most IDEs or code editors have beautifier plugins that can be configured to run -clang-format automatically, for example, each time you save a file. - -Here is a non-exhaustive list of beautifier plugins for some IDEs: - -- Qt Creator: `Beautifier plugin `__ -- Visual Studio Code: `Clang-Format `__ -- Visual Studio: `Clang Power Tools 2022 `__ -- vim: `vim-clang-format `__ -- CLion: Starting from version ``2019.1``, no plugin is required. Instead, enable - `ClangFormat `__ - -(Pull requests are welcome to extend this list with tested plugins.) - -.. _doc_code_style_guidelines_header_includes: - -Header includes -~~~~~~~~~~~~~~~ - -When adding new C++ or Objective-C files or including new headers in existing -ones, the following rules should be followed: - -- The first lines in the file should be Godot's copyright header and MIT - license, copy-pasted from another file. Make sure to adjust the filename. -- In a ``.h`` header, include guards should be used with the form - ``FILENAME_H``. - -- In a ``.cpp`` file (e.g. ``filename.cpp``), the first include should be the - one where the class is declared (e.g. ``#include "filename.h"``), followed by - an empty line for separation. -- Then come headers from Godot's own code base, included in alphabetical order - (enforced by ``clang-format``) with paths relative to the root folder. Those - includes should be done with quotes, e.g. ``#include "core/object.h"``. The - block of Godot header includes should then be followed by an empty line for - separation. -- Finally, third-party headers (either from ``thirdparty`` or from the system's - include paths) come next and should be included with the < and > symbols, e.g. - ``#include ``. The block of third-party headers should also be followed - by an empty line for separation. -- Godot and third-party headers should be included in the file that requires - them, i.e. in the `.h` header if used in the declarative code or in the `.cpp` - if used only in the imperative code. - -Example: - -.. code-block:: cpp - :caption: my_new_file.h - - /**************************************************************************/ - /* my_new_file.h */ - /**************************************************************************/ - /* This file is part of: */ - /* GODOT ENGINE */ - /* https://godotengine.org */ - /**************************************************************************/ - /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ - /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ - /* */ - /* Permission is hereby granted, free of charge, to any person obtaining */ - /* a copy of this software and associated documentation files (the */ - /* "Software"), to deal in the Software without restriction, including */ - /* without limitation the rights to use, copy, modify, merge, publish, */ - /* distribute, sublicense, and/or sell copies of the Software, and to */ - /* permit persons to whom the Software is furnished to do so, subject to */ - /* the following conditions: */ - /* */ - /* The above copyright notice and this permission notice shall be */ - /* included in all copies or substantial portions of the Software. */ - /* */ - /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ - /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ - /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */ - /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ - /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ - /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ - /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ - /**************************************************************************/ - - #pragma once - - #include "core/hash_map.h" - #include "core/list.h" - #include "scene/gui/control.h" - - #include - -.. code-block:: cpp - :caption: my_new_file.cpp - - /**************************************************************************/ - /* my_new_file.cpp */ - /**************************************************************************/ - /* This file is part of: */ - /* GODOT ENGINE */ - /* https://godotengine.org */ - /**************************************************************************/ - /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ - /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ - /* */ - /* Permission is hereby granted, free of charge, to any person obtaining */ - /* a copy of this software and associated documentation files (the */ - /* "Software"), to deal in the Software without restriction, including */ - /* without limitation the rights to use, copy, modify, merge, publish, */ - /* distribute, sublicense, and/or sell copies of the Software, and to */ - /* permit persons to whom the Software is furnished to do so, subject to */ - /* the following conditions: */ - /* */ - /* The above copyright notice and this permission notice shall be */ - /* included in all copies or substantial portions of the Software. */ - /* */ - /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ - /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ - /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */ - /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ - /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ - /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ - /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ - /**************************************************************************/ - - #include "my_new_file.h" - - #include "core/math/math_funcs.h" - #include "scene/gui/line_edit.h" - - #include - #include - -Java ----- - -Godot's Java code (mostly in ``platform/android``) is also enforced via -``clang-format``, so see the instructions above to set it up. Keep in mind that -this style guide only applies to code written and maintained by Godot, not -third-party code such as the ``java/src/com/google`` subfolder. - -Python ------- - -Godot's SCons buildsystem is written in Python, and various scripts included -in the source tree are also using Python. - -For those, we use the `Ruff linter and code formatter `__. - -Using ruff locally -~~~~~~~~~~~~~~~~~~~ - -First of all, you will need to install Ruff. Ruff requires Python 3.7+ to run. - -Installation -^^^^^^^^^^^^ - -Here's how to install ruff: - -:: - - pip3 install ruff --user - - -You then have different possibilities to apply ruff to your changes: - -Manual usage -^^^^^^^^^^^^ - -You can apply ``ruff`` manually to one or more files with the following -command: - -:: - - ruff format --line-length 120 - -- ``--line-length 120`` means that the allowed number of characters per line is 120. - This number was agreed upon by the developers. -- The path can point to several files, either one after the other or using - wildcards like in a typical Unix shell. - - -Pre-commit hook -~~~~~~~~~~~~~~~ - -For ease of use, we provide hooks for Git with the `pre-commit `__ -Python framework that will run ``ruff`` automatically on all your commits with the -correct version of ``ruff``. -To set up: - -:: - - pip install pre-commit - pre-commit install - - -You can also run the hook manually with ``pre-commit run``. - -.. note:: - - Previously, we supplied a hook in the folder ``misc/hooks``. If you copied the - script manually, these hooks should still work, but symlinks will be broken. - If you are using the new system, run ``rm .git/hooks/*`` to remove the old hooks - that are no longer needed. - - -Editor integration -^^^^^^^^^^^^^^^^^^ - -Many IDEs or code editors have beautifier plugins that can be configured to run -ruff automatically, for example, each time you save a file. For details, you can -check `Ruff Editor Integrations `__. - -Comment style guide -------------------- - -This comment style guide applies to all programming languages used within -Godot's codebase. - -- Begin comments with a space character to distinguish them from disabled code. -- Use sentence case for comments. Begin comments with an uppercase character and - always end them with a period. -- Reference variable/function names and values using backticks. -- Wrap comments to ~100 characters. -- You can use ``TODO:``, ``FIXME:``, ``NOTE:``, ``WARNING:``, or ``HACK:`` as admonitions - when needed. - -**Example:** - -.. code-block:: cpp - - // Compute the first 10,000 decimals of Pi. - // FIXME: Don't crash when computing the 1,337th decimal due to `increment` - // being negative. - -Don't repeat what the code says in a comment. Explain the *why* rather than *how*. - -**Bad:** - -.. code-block:: cpp - - // Draw loading screen. - draw_load_screen(); - -You can use Javadoc-style comments above function or macro definitions. It's -recommended to use Javadoc-style comments *only* for methods which are not -exposed to scripting. This is because exposed methods should be documented in -the :ref:`class reference XML ` -instead. - -**Example:** - -.. code-block:: cpp - - /** - * Returns the number of nodes in the universe. - * This can potentially be a very large number, hence the 64-bit return type. - */ - uint64_t Universe::get_node_count() { - // ... - } - -For member variables, don't use Javadoc-style comments, but use single-line comments instead: - -.. code-block:: cpp - - class Universe { - // The cached number of nodes in the universe. - // This value may not always be up-to-date with the current number of nodes - // in the universe. - uint64_t node_count_cached = 0; - }; diff --git a/contributing/development/configuring_an_ide/img/kdevelop_addincludes.webp b/contributing/development/configuring_an_ide/img/kdevelop_addincludes.webp deleted file mode 100644 index 69a5a13ce..000000000 Binary files a/contributing/development/configuring_an_ide/img/kdevelop_addincludes.webp and /dev/null differ diff --git a/contributing/development/configuring_an_ide/img/kdevelop_buildconfig.webp b/contributing/development/configuring_an_ide/img/kdevelop_buildconfig.webp deleted file mode 100644 index abc660b2e..000000000 Binary files a/contributing/development/configuring_an_ide/img/kdevelop_buildconfig.webp and /dev/null differ diff --git a/contributing/development/configuring_an_ide/img/kdevelop_configlaunches.webp b/contributing/development/configuring_an_ide/img/kdevelop_configlaunches.webp deleted file mode 100644 index 2199dd05f..000000000 Binary files a/contributing/development/configuring_an_ide/img/kdevelop_configlaunches.webp and /dev/null differ diff --git a/contributing/development/configuring_an_ide/img/kdevelop_configlaunches2.webp b/contributing/development/configuring_an_ide/img/kdevelop_configlaunches2.webp deleted file mode 100644 index 8095e2ef2..000000000 Binary files a/contributing/development/configuring_an_ide/img/kdevelop_configlaunches2.webp and /dev/null differ diff --git a/contributing/development/configuring_an_ide/img/kdevelop_custombuild.webp b/contributing/development/configuring_an_ide/img/kdevelop_custombuild.webp deleted file mode 100644 index 2f96026ff..000000000 Binary files a/contributing/development/configuring_an_ide/img/kdevelop_custombuild.webp and /dev/null differ diff --git a/contributing/development/configuring_an_ide/img/kdevelop_newproject.webp b/contributing/development/configuring_an_ide/img/kdevelop_newproject.webp deleted file mode 100644 index 97863f2ca..000000000 Binary files a/contributing/development/configuring_an_ide/img/kdevelop_newproject.webp and /dev/null differ diff --git a/contributing/development/configuring_an_ide/img/kdevelop_openconfig.webp b/contributing/development/configuring_an_ide/img/kdevelop_openconfig.webp deleted file mode 100644 index e9719d6e4..000000000 Binary files a/contributing/development/configuring_an_ide/img/kdevelop_openconfig.webp and /dev/null differ diff --git a/contributing/development/cpp_usage_guidelines.rst b/contributing/development/cpp_usage_guidelines.rst deleted file mode 100644 index 06967e1c4..000000000 --- a/contributing/development/cpp_usage_guidelines.rst +++ /dev/null @@ -1,130 +0,0 @@ -.. _doc_cpp_usage_guidelines: - -C++ usage guidelines -==================== - -Rationale ---------- - -Since Godot 4.0, the C++ standard used throughout the codebase is a subset of -**C++17**. While modern C++ brings a lot of opportunities to write faster, more -readable code, we chose to restrict our usage of C++ to a subset for a few -reasons: - -- It makes it easier to review code in online editors. This is because engine - contributors don't always have access to a full-featured IDE while reviewing - code. -- It makes the code easier to grasp for beginner contributors (who may not be - professional C++ programmers). Godot's codebase is known to be easy to learn - from, and we'd like to keep it that way. - -To get your pull request merged, it needs to follow the C++ usage guidelines -outlined here. Of course, you can use features not allowed here in your own C++ -modules or GDExtensions. - -.. note:: - - Prior to Godot 4.0, the C++ standard used throughout the codebase was C++03, - with a handful of C++14 extensions. If you are contributing a pull request - to the `3.x` branch rather than `master`, your code can't use C++17 features. - Instead, your code must be able to be built with a C++14 compiler. - - The guidelines below don't apply to third-party dependencies, although we - generally favor small libraries instead of larger solutions. See also - :ref:`doc_best_practices_for_engine_contributors`. - -.. seealso:: - - See :ref:`doc_code_style_guidelines` for formatting guidelines. - -Disallowed features -------------------- - -**Any feature not listed below is allowed.** Using features like ``constexpr`` -variables and ``nullptr`` is encouraged when possible. Still, try to keep your -use of modern C++ features conservative. Their use needs to serve a real -purpose, such as improving code readability or performance. - -.. _doc_cpp_godot_types: - -Standard Template Library -~~~~~~~~~~~~~~~~~~~~~~~~~ - -We don't allow using the `STL `__ -as Godot provides its own data types (among other things). -See :ref:`doc_faq_why_not_stl` for more information. - -This means that pull requests should **not** use ``std::string``, -``std::vector`` and the like. Instead, use Godot's datatypes as described in -the :ref:`doc_core_types` documentation. - -A 📜 icon denotes the type is part of :ref:`Variant `. This -means it can be used as a parameter or return value of a method exposed to the -scripting API. - -``auto`` keyword -~~~~~~~~~~~~~~~~ - -Please don't use the ``auto`` keyword for type inference. While it can avoid -repetition, it can also lead to confusing code: - -.. code-block:: cpp - - // Not so confusing... - auto button = memnew(Button); - - // ...but what about this? - auto result = EditorNode::get_singleton()->get_complex_result(); - -Keep in mind hover documentation often isn't readily available for pull request -reviewers. Most of the time, reviewers will use GitHub's online viewer to review -pull requests. - -The ``auto`` keyword can be used in some special cases, like C++ lambda or Objective-C block -definitions and C++ templates. Please ask before using templates with ``auto`` in a pull request. - -.. code-block:: cpp - - // Full type definitions. - void (*mult64to128)(uint64_t, uint64_t, uint64_t &, uint64_t &) = [](uint64_t u, uint64_t v, uint64_t &h, uint64_t &l) { ... } - void (^JOYSTICK_LEFT)(GCControllerDirectionPad *__strong, float, float) = ^(GCControllerDirectionPad *dpad, float xValue, float yValue) { ... } - - // Less clutter with auto. - auto mult64to128 = [](uint64_t u, uint64_t v, uint64_t &h, uint64_t &l) { ... } - auto JOYSTICK_LEFT = ^(GCControllerDirectionPad *dpad, float xValue, float yValue) { ... } - - // Compare function for different types. - template - constexpr auto MIN(const T1 m_a, const T2 m_b) { - return m_a < m_b ? m_a : m_b; - } - -We chose to forbid ``auto`` in all other cases. Thank you for your understanding. - -Lambdas -~~~~~~~ - -Lambdas should be used conservatively when they make code effectively faster or -simpler, and do not impede readability. Please ask before using lambdas in a -pull request. - -``#ifdef``-based include guards -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Starting with 4.5, all files now use the ``#pragma once`` directive, as they -improve readability and declutter macros. Use of ``#ifdef``-based include -guards are now actively discouraged. - -``try``-``catch`` blocks -~~~~~~~~~~~~~~~~~~~~~~~~ - -C++ style exception handling using ``try`` and ``catch`` blocks is forbidden. -This restriction is in place for several reasons, including performance, binary -size and code complexity. -Use :ref:`doc_common_engine_methods_and_macros_error_macros` instead. - - -.. seealso:: - - See :ref:`doc_code_style_guidelines_header_includes` for guidelines on sorting - includes in C++ and Objective-C files. diff --git a/contributing/development/editor/editor_style_guide.rst b/contributing/development/editor/editor_style_guide.rst deleted file mode 100644 index e349b0b4b..000000000 --- a/contributing/development/editor/editor_style_guide.rst +++ /dev/null @@ -1,98 +0,0 @@ -.. _doc_editor_style_guide: - -Editor style guide -================== - -Introduction ------------- - -Thanks for your interest in contributing to the Godot editor! - -This page describes the grammar and writing style used throughout the Godot -editor. Following this style guide will help your contribution get merged faster -since there will be fewer review steps required. - -Writing style -------------- - -- **Write messages (errors, warnings, ...) as full sentences.** They should start - with an uppercase letter and end with a period. -- **Try to keep sentences short.** This makes it more likely that their translations - will be short as well, which is a good thing to avoid UI bugs. -- **Use contractions.** For example, use "isn't" instead of "is not". An exception - to this rule can be made when you specifically want to emphasize one of the - contraction's words. -- **Use double quotes in messages** (``""``) instead of single quotes (``''``). - Double quotes should be used to quote user input, file paths and possibly - other things depending on the context. - -.. seealso:: - - Try to follow the :ref:`doc_docs_writing_guidelines` in addition to the - guidelines outlined above. - -Button and menu texts ---------------------- - -Capitalize text in buttons and menu actions: - -- **Good:** *Open Editor Data Folder* -- **Bad:** *Open editor data folder* - -If a menu action opens a modal dialog, suffix it with an ellipsis (``...``). - -- **Good:** *Editor Settings...* -- **Bad:** *Editor Settings* - -Inspector sections ------------------- - -In general, don't create sections that contain less than 3 items. Sections that -contain few items make it difficult to navigate the inspector, while missing the -benefits of using sections such as folding. - -There are some valid exceptions for this, such as material features in -:ref:`class_StandardMaterial3D`. - -This advice also applies to the Project Settings and Editor Settings. - -Inspector performance hints ---------------------------- - -Enum properties that noticeably impact performance should have a performance -hint associated. The hint should refer to the *absolute* performance impact, -rather than being relative to the other options provided in the enum. Here are -some examples taken from the Godot editor: - -- **Screen-space antialiasing:** *Disabled (Fastest), FXAA (Fast)* -- **MSAA quality:** *Disabled (Fastest), 2x (Fast), 4x (Average), 8x (Slow), 16x - (Slower)* -- **DirectionalLight mode:** *Orthogonal (Fast), PSSM 2 Splits - (Average), PSSM 4 Splits (Slow)* - -For consistency, try to stick to the terms below (from fastest to slowest): - -- *Fastest, Faster, Fast, Average, Slow, Slower, Slowest* - -Their usage doesn't have to be contiguous. For example, you can use only "Fast" -and "Slow" from the list above. - -If you're adding a new enum, its values should be ordered from the fastest -option to the slowest option. - -Tooltips --------- - -Consider adding tooltips whenever the action performed by a button or menu -action isn't obvious. You can also provide additional context or highlight -caveats in the tooltip. - -You can do this by calling ``set_tooltip(TTR("Text here."))`` on the -Control-based node in question. If the tooltip is particularly long (more than -~80 characters), wrap it over several lines by adding line breaks using ``\n``. - -Tooltips should follow the writing style described above. In addition to this, -use indicative mood instead of imperative mood: - -- **Good:** *Computes global illumination for the selected GIProbe.* -- **Bad:** *Compute global illumination for the selected GIProbe.* diff --git a/contributing/development/editor/index.rst b/contributing/development/editor/index.rst deleted file mode 100644 index 6df59a08a..000000000 --- a/contributing/development/editor/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -:allow_comments: False - -Editor development -================== - -.. toctree:: - :maxdepth: 1 - :name: toc-devel-editor - - introduction_to_editor_development - creating_icons - editor_style_guide diff --git a/contributing/development/img/best_practices1.png b/contributing/development/img/best_practices1.png deleted file mode 100644 index 96d3d1229..000000000 Binary files a/contributing/development/img/best_practices1.png and /dev/null differ diff --git a/contributing/development/img/best_practices2.png b/contributing/development/img/best_practices2.png deleted file mode 100644 index 364e86a06..000000000 Binary files a/contributing/development/img/best_practices2.png and /dev/null differ diff --git a/contributing/development/img/best_practices3.png b/contributing/development/img/best_practices3.png deleted file mode 100644 index 3ecd55461..000000000 Binary files a/contributing/development/img/best_practices3.png and /dev/null differ diff --git a/contributing/development/img/best_practices4.png b/contributing/development/img/best_practices4.png deleted file mode 100644 index bcc442888..000000000 Binary files a/contributing/development/img/best_practices4.png and /dev/null differ diff --git a/contributing/development/img/best_practices5.png b/contributing/development/img/best_practices5.png deleted file mode 100644 index 5a50c2e21..000000000 Binary files a/contributing/development/img/best_practices5.png and /dev/null differ diff --git a/contributing/development/img/best_practices6.png b/contributing/development/img/best_practices6.png deleted file mode 100644 index d8aa630cc..000000000 Binary files a/contributing/development/img/best_practices6.png and /dev/null differ diff --git a/contributing/development/img/best_practices7.png b/contributing/development/img/best_practices7.png deleted file mode 100644 index 4bd0aa180..000000000 Binary files a/contributing/development/img/best_practices7.png and /dev/null differ diff --git a/contributing/development/img/best_practices8.png b/contributing/development/img/best_practices8.png deleted file mode 100644 index 3c3dccd95..000000000 Binary files a/contributing/development/img/best_practices8.png and /dev/null differ diff --git a/contributing/development/index.rst b/contributing/development/index.rst deleted file mode 100644 index ce3a3f746..000000000 --- a/contributing/development/index.rst +++ /dev/null @@ -1,44 +0,0 @@ -:allow_comments: False - -.. _doc_contributing_to_the_engine: - -Engine development -================== - -The guides below explain how to contribute to the engine's codebase. You will learn -about best practices when working on solutions and features, the code style and the -internal structure of the codebase, how to set up your working environment, and more. - -Be sure to also check the :ref:`workflow guidelines `, -especially if you're new to using Git or GitHub. - -.. toctree:: - :maxdepth: 1 - :name: toc-contributing-to-the-engine - - best_practices_for_engine_contributors - code_style_guidelines - cpp_usage_guidelines - handling_compatibility_breakages - -Buildsystem and work environment --------------------------------- - -.. toctree:: - :maxdepth: 1 - :name: toc-contributing-to-the-engine-environment - - configuring_an_ide/index - compiling/index - debugging/index - -Engine architecture -------------------- - -.. toctree:: - :maxdepth: 1 - :name: toc-contributing-to-the-engine-architecture - - core_and_modules/index - file_formats/index - editor/index diff --git a/contributing/documentation/building_the_manual.rst b/contributing/documentation/building_the_manual.rst deleted file mode 100644 index eb732febc..000000000 --- a/contributing/documentation/building_the_manual.rst +++ /dev/null @@ -1,194 +0,0 @@ -.. _doc_building_the_manual: - -Building the manual with Sphinx -=============================== - -This page explains how to build a local copy of the Godot manual using the -Sphinx docs engine. This allows you to have local HTML files and build the -documentation as a PDF, EPUB, or LaTeX file, for example. - -Before you get started, make sure that you have: - -- `Git `_ -- `make `_ (unless you're using Windows) -- `Python `_ 3 - -.. note:: Python 3 should come with the ``pip3`` command. You may need to write - ``python3 -m pip`` (Unix) or ``py -m pip`` (Windows) instead of ``pip3``. - If both approaches fail, `make sure that you have pip3 installed - `__. - -1. *(Optional)* Set up a virtual environment. Virtual environments prevent - potential conflicts between the Python packages in ``requirements.txt`` and - other Python packages that are installed on your system. - - a. Create the virtual environment: - - .. tabs:: - - .. group-tab:: Windows - - .. code:: pwsh - - py -m venv godot-docs-venv - - .. group-tab:: Other platforms - - .. code:: sh - - python3 -m venv godot-docs-venv - - b. Activate the virtual environment: - - .. tabs:: - - .. group-tab:: Windows - - .. code:: pwsh - - godot-docs-venv\Scripts\activate.bat - - .. group-tab:: Other platforms - - .. code:: sh - - source godot-docs-venv/bin/activate - - c. *(Optional)* Update pre-installed packages: - - .. tabs:: - - .. group-tab:: Windows - - .. code:: pwsh - - py -m pip install --upgrade pip setuptools - - .. group-tab:: Other platforms - - .. code:: sh - - pip3 install --upgrade pip setuptools - -2. Clone the docs repo: - - .. code:: sh - - git clone https://github.com/godotengine/godot-docs.git - -3. Change directory into the docs repo: - - .. code:: sh - - cd godot-docs - -4. Install the required packages: - - .. code:: sh - - pip3 install -r requirements.txt - -5. Build the docs: - - .. code:: sh - - make html - - .. note:: - On Windows, that command will run ``make.bat`` instead of GNU Make (or an alternative). - - Alternatively, you can build the documentation by running the sphinx-build program manually: - - .. code:: sh - - sphinx-build -b html ./ _build/html - -The compilation will take some time as the ``classes/`` folder contains hundreds of files. -See :ref:`doc_building_the_manual:performance`. - -You can then browse the documentation by opening ``_build/html/index.html`` in -your web browser. - -Dealing with errors -------------------- - -If you run into errors, you may try the following command: - -.. code:: sh - - make SPHINXBUILD=~/.local/bin/sphinx-build html - -If you get a ``MemoryError`` or ``EOFError``, you can remove the ``classes/`` folder and -run ``make`` again. -This will drop the class references from the final HTML documentation, but will keep the -rest intact. - -.. important:: - If you delete the ``classes/`` folder, do not use ``git add .`` when working on a pull - request or the whole ``classes/`` folder will be removed when you commit. - See `#3157 `__ for more detail. - -.. _doc_building_the_manual:performance: - -Hints for performance ---------------------- - -RAM usage -~~~~~~~~~ - -Building the documentation requires at least 8 GB of RAM to run without disk swapping, -which slows it down. -If you have at least 16 GB of RAM, you can speed up compilation by running: - -.. tabs:: - - .. group-tab:: Windows - - .. code:: pwsh - - set SPHINXOPTS=-j2 && make html - - .. group-tab:: Other platforms - - .. code:: sh - - make html SPHINXOPTS=-j2 - -You can use ``-j auto`` to use all available CPU threads, but this can use a lot -of RAM if you have a lot of CPU threads. For instance, on a system with 32 CPU -threads, ``-j auto`` (which corresponds to ``-j 32`` here) can require 20+ GB of -RAM for Sphinx alone. - -Specifying a list of files -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. warning:: - - This section will not work on Windows, since the repository is using - a simplified ``make.bat`` script instead of the real GNU Make program. - If you would like to get a Linux terminal on your system, consider using - `Windows Subsystem for Linux (WSL) `__. - -You can specify a list of files to build, which can greatly speed up compilation: - -.. code:: sh - - make html FILELIST='classes/class_node.rst classes/class_resource.rst' - -The list of files can also be provided by the ``git`` command. -This way you can automatically get the names of all files that have changed since -the last commit (``sed`` is used to put them on the same line). - -.. code:: sh - - make html FILELIST="$(git diff HEAD --name-only | sed -z 's/\n/ /g')" - -You can replace ``HEAD`` with ``master`` to return all files changed from the -``master`` branch: - -.. code:: sh - - make html FILELIST="$(git diff master --name-only | sed -z 's/\n/ /g')" - -If any images were modified, the output will contain some warnings about them, -but the build will proceed correctly. diff --git a/contributing/documentation/content_guidelines.rst b/contributing/documentation/content_guidelines.rst deleted file mode 100644 index ffd744671..000000000 --- a/contributing/documentation/content_guidelines.rst +++ /dev/null @@ -1,94 +0,0 @@ -.. _doc_content_guidelines: - -Content guidelines -================== - -This document outlines what should be included in the official documentation. -Below, you will find a couple of principles and recommendations for writing -accessible content. - -We want to achieve two goals: - -1. **Empathize with our users.** We should write in a way that makes it easy for - them to learn from the docs. -2. **Write a complete reference manual**. Our goal here is not to teach - programming fundamentals. Instead, our goal is to provide a reference for how - Godot's features work. - -Guidelines and principles -------------------------- - -Below are the guidelines we should strive to follow. They are not hard rules, -though: sometimes, a topic will require breaking one or more of them. -Still, we should strive to achieve the two goals listed above. - -Writing complete and accessible documentation -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -**A feature doesn't exist unless it is documented**. If a user can't find -information about a feature and how it works, it doesn't exist to them. We -should ensure that we cover everything Godot does. - -.. note:: - - When adding or updating an engine feature, the documentation team needs to - know about it. Contributors should open an issue on the `godot-docs` repository - when their work gets merged and requires documentation. - -Do your best to keep documents **under 1000 words in length**. If a page goes -past that threshold, consider splitting it into two parts. Limiting page size -forces us to write concisely and to break up large documents so that each page -focuses on a particular problem. - -Each page or section of a page should clearly state what **problem** it tackles -and what it will teach the user. Users need to know if they're reading the -correct guide for solving the problems they're encountering. For example, -instead of writing the heading "Signals", consider writing "Reacting to changes -with signals". The second title makes it clear what the purpose of signals is. - -.. note:: - - Long section titles lead to long entries in the side menu, which can make - navigation cumbersome. Try to keep headings five words long or less. - -If the page assumes specific knowledge of other Godot features, mention it and -link to the corresponding documentation. For instance, a page about physics -may use signals, in which case you could note that the signals tutorial is a -prerequisite. You may also link to other websites for prerequisites beyond the -documentation's scope. For example, you could link to an introduction to -programming in the getting started guide, or a website that teaches math theory -in the math section. - -Limiting cognitive load -~~~~~~~~~~~~~~~~~~~~~~~ - -Limit the cognitive load required to read the documentation. The simpler and -more explicit language we use, the more efficient it becomes for people to -learn. You can do so by: - -1. Introducing only one new concept at a time whenever possible. -2. Using simple English, as we recommend in our writing guidelines. -3. Including one or more **concrete usage examples**. Prefer a real-world example - to one that uses names like ``foo``, ``bar``, or ``baz``. - -While many people may understand more complex language and abstract examples, -you will lose others. Understandable writing and practical examples benefit -everyone. - -Always make an effort to **put yourself in the user's shoes**. When we -understand something thoroughly, it becomes obvious to us. We may fail to think -about details relevant to a newcomer, but **good documentation meets users where -they are**. We should explain each feature's capabilities or intended uses with -the most straightforward language possible. - -Try to remember what you first needed to know when learning about the feature or -concept. What new terms did you need to learn? What confused you? What was the -hardest to grasp? You will want users to review your work, and we recommend you -practice explaining the feature before writing about it. - -.. note:: - - Programming fundamentals are a prerequisite for using a complex engine like - Godot. Talking about variables, functions, or classes is acceptable. But we - should favor plain language over specific terminology like - "metaprogramming". If you need to use precise terms, be sure to define them. diff --git a/contributing/documentation/contributing_to_the_documentation.rst b/contributing/documentation/contributing_to_the_documentation.rst deleted file mode 100644 index e366698c6..000000000 --- a/contributing/documentation/contributing_to_the_documentation.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _doc_contributing_to_the_documentation: - -Contributing to the documentation -================================= - -This guide explains how to contribute to Godot's documentation, be it by -writing or reviewing pages. - -.. seealso:: - - If you want to translate pages or the class reference from English to other - languages, read :ref:`doc_editor_and_docs_localization`. - -Getting started ---------------- - -To modify or create pages in the reference manual, you need to edit ``.rst`` -files in the `godot-docs GitHub repository -`_. Modifying those pages in a pull -request triggers a rebuild of the online documentation upon merging. - -.. seealso:: For details on Git usage and the pull request workflow, please - refer to the :ref:`doc_pr_workflow` page. Most of what it describes - regarding the main godotengine/godot repository is also valid for - the docs repository. - -.. warning:: The class reference's source files are in the `Godot engine - repository `_. We generate - the :ref:`Class Reference ` section of this documentation - from them. If you want to update the description of a class, its - methods, or properties, read - :ref:`doc_updating_the_class_reference`. - -What is the Godot documentation -------------------------------- - -The Godot documentation is intended as a comprehensive reference manual for the -Godot game engine. It is not meant to contain step-by-step tutorials, except for -two game creation tutorials in the Getting Started section. - -We strive to write factual content in an accessible and well-written language. To -contribute, you should also read: - -1. :ref:`doc_docs_writing_guidelines`. There, you will find rules and - recommendations to write in a way that everyone understands. -2. :ref:`doc_content_guidelines`. They explain the principles we follow to write the - documentation and the kind of content we accept. - -Contributing changes --------------------- - -**Pull requests should use the** ``master`` **branch by default.** Only make pull -requests against other branches (e.g. ``3.6`` or ``4.2``) if your changes only -apply to that specific version of Godot. After a pull request is merged into -``master``, it will usually be cherry-picked into the current stable branch by -documentation maintainers. - -Though less convenient to edit than a wiki, this Git repository is where we -write the documentation. Having direct access to the source files in a revision -control system is a plus to ensure our documentation quality. - -Editing existing pages -~~~~~~~~~~~~~~~~~~~~~~ - -To edit an existing page, locate its ``.rst`` source file and open it in your -favorite text editor. You can then commit the changes, push them to your fork, -and make a pull request. **Note that the pages in** ``classes/`` **should not be -edited here.** They are automatically generated from Godot's `XML class -reference `__. -See :ref:`doc_updating_the_class_reference` for details. - -.. seealso:: To build the manual and test changes on your computer, see - :ref:`doc_building_the_manual`. - -Editing pages online --------------------- - -You can edit the documentation online by clicking the **Edit on GitHub** link in -the top-right of every page. - -Doing so takes you to the GitHub text editor. You need to have a GitHub account -and to log in to use it. Once logged in, you can propose change like so: - -1. Click the **Edit on GitHub** button. - -2. On the GitHub page you're taken to, make sure the current branch is "master". - Click the pencil icon in the top-right corner - near the **Raw**, **Blame**, and **Delete** buttons. - It has the tooltip "Fork this project and edit the file". - -3. Edit the text in the text editor. - -4. Click "Commit changes...", summarize the changes you made - and make sure to replace the placeholder "Update file.rst" by a short, - but clear one-line description, as this is the commit title. - Click the button **Propose changes**. - -5. On the following screens, click the **Create pull request** button until you - see a message like *Username wants to merge 1 commit into godotengine:master - from Username:patch-1*. - -.. note:: - - If there are more commits than your own in the pull request - it is likely that your branch was created using the wrong origin, - due to "master" not being the current branch in step 2. - You will need to rebase your branch to "master" or create a new branch. - -Another contributor will review your changes and merge them into the docs if -they're good. They may also make changes or ask you to do so before merging. - -Adding new pages ----------------- - -Before adding a new page, please ensure that it fits in the documentation: - -1. Look for `existing issues - `_ or open a new one to see - if the page is necessary. -2. Ensure there isn't a page that already covers the topic. -3. Read our :ref:`doc_content_guidelines`. - -To add a new page, create a ``.rst`` file with a meaningful name in the section you -want to add a file to, e.g. ``tutorials/3d/light_baking.rst``. - -You should then add your page to the relevant "toctree" (table of contents, -e.g. ``tutorials/3d/index.rst``). Add your new filename to the list on a new -line, using a relative path and no extension, e.g. here ``light_baking``. - -Titles -~~~~~~ - -Always begin pages with their title and a Sphinx reference name: - -:: - - .. _doc_insert_your_title_here: - - Insert your title here - ====================== - -The reference ``_doc_insert_your_title_here`` and the title should match. - -The reference allows linking to this page using the ``:ref:`` format, e.g. -``:ref:`doc_insert_your_title_here``` would link to the above example page (note -the lack of leading underscore in the reference). - -Write your titles like plain sentences, without capitalizing each word: - -- **Good:** Understanding signals in Godot -- **Bad:** Understanding Signals In Godot - -Only proper nouns, projects, people, and node class names should have their -first letter capitalized. - -Sphinx and reStructuredText syntax -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Check Sphinx's `reST Primer `__ -and the `official reference `__ for -details on the syntax. - -Sphinx uses specific reST comments to do specific operations, like defining the -table of contents (``.. toctree::``) or cross-referencing pages. Check the -`official Sphinx documentation -`__ for more details. To learn -how to use Sphinx directives like ``.. note::`` or ``.. seealso::``, check out -the `Sphinx directives documentation -`__. - -Adding images and attachments -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To add images, please put them in an ``img/`` folder next to the ``.rst`` file with -a meaningful name and include them in your page with: - -.. code:: rst - - .. image:: img/image_name.webp - -Alternatively, you can use the `figure` directive, which gives the image a contrasting -border and allows centering it on the page. - -.. code:: rst - - .. figure:: img/image_name.webp - :align: center - -You can also include attachments as support material for a tutorial, by placing them -into a ``files/`` folder next to the ``.rst`` file, and using this inline markup: - -.. code:: rst - - :download:`file_name.zip ` - -Consider using the `godot-docs-project-starters ` -repository for hosting support materials, such as project templates and asset packs. -You can use a direct link to the generated archive from that repository with the regular -link markup: - -.. code:: rst - - `file_name.zip `_ - - -License -------- - -This documentation and every page it contains is published under the terms of -the `Creative Commons Attribution 3.0 license (CC BY 3.0) -`_, with attribution to "Juan -Linietsky, Ariel Manzur and the Godot community". - -By contributing to the documentation on the GitHub repository, you agree that -your changes are distributed under this license. diff --git a/contributing/documentation/docs_contribution_checklist.rst b/contributing/documentation/docs_contribution_checklist.rst deleted file mode 100644 index ed7186a53..000000000 --- a/contributing/documentation/docs_contribution_checklist.rst +++ /dev/null @@ -1,71 +0,0 @@ -.. _docs_contribution_checklist: - -Documentation contribution checklist -==================================== - -This page is a summary of the guidelines to follow when contributing to the -documentation. Before you press that **Create pull request** button on GitHub, -read over this list to double check if you missed anything. - -You don't need to read all the guidelines here in order to start contributing. -If you do miss something, it will be pointed out during review. However, -following the guidelines you are aware of as best you can will help speed up the -review process. - -Writing style -------------- - -:ref:`See here. ` - -- Use the active voice. -- Use precise action verbs. -- Avoid verbs that end in -ing. -- Remove unnecessary adverbs and adjectives. -- Ban these 8 words: obvious, simple, basic, easy, actual, just, clear, and however. -- Use explicit references. -- Use 's to show possession. -- Use the Oxford comma. - -Code examples -------------- - -- Use dynamic typing. :ref:`See here. ` -- Use real, practical examples. Avoid ``foo`` / ``bar`` examples. :ref:`See here. ` - -Manual style and formatting ---------------------------- - -- Use common vocabulary for the editor interface. :ref:`See here. ` -- Use ``:kbd:`` for keyboard shortcuts. :ref:`See here. ` -- Literals use ``code style``. :ref:`See here. ` -- Classes link to the class reference once, then use ``ClassName`` for the rest - of the page. - Methods and properties link to the class ref once, then use ``PropertyName`` - for the rest of the page. :ref:`See here. ` -- Editor UI, like menus, windows, and editor navigation paths, use - ``Bold Style``. :ref:`See here. ` -- Link to project settings when referencing them. :ref:`See here. ` -- Text is manually wrapped to 80-100 characters. :ref:`See here. ` -- No trailing whitespace at the end of lines. -- Most of the time, avoid mentioning a specific Godot version. :ref:`See here. ` - -Images and videos ------------------ - -- New (and updated) images are in WebP format. :ref:`See here. ` -- Editor screenshots are cropped. :ref:`See here. ` -- Images larger than 1080p or 300kb are scaled down. :ref:`See here. ` -- Outlines in images use ``fffb44`` yellow. :ref:`See here. ` -- Videos use the ``:autoplay:``, ``:loop:``, and ``:muted:`` tags. :ref:`See here. ` - -GitHub ------- - -- The PR title starts with a word like ``Fix``, ``Add``, ``Update``, - ``Clarify``, or ``Improve``. -- If the PR closes an issue, link to the issue with one of GitHub's - `keywords `__: - ``closes``, ``fixes``, or ``resolves``, in the text of the PR. -- Ideally, PR contains a single commit. However, multiple commits can be - :ref:`squashed ` later. - diff --git a/contributing/documentation/docs_image_guidelines.rst b/contributing/documentation/docs_image_guidelines.rst deleted file mode 100644 index 10a4ba1cf..000000000 --- a/contributing/documentation/docs_image_guidelines.rst +++ /dev/null @@ -1,267 +0,0 @@ -.. _docs_image_guidelines: - -Creating documentation images and videos -======================================== - -Throughout the documentation, images are often needed to make the explanation -of a feature or concept as clear as possible for a reader. This page will -explain the process from beginning to end. - -Images ------- - -Capturing an image -~~~~~~~~~~~~~~~~~~ - -To take a picture of something in Godot, a screen capture tool can be used. - -On Windows 10 and 11 that would be the Snip & Sketch program. -Pressing :kbd:`Windows + Shift + S` lets you take a screenshot -of a portion of the screen and save it to the clipboard. -After pressing those keys, click and drag over -the area you wish to take a picture of. - -On macOS, pressing :kbd:`Shift + Command + 3` does the same. -To take a picture of the entire screen press :kbd:`Shift + Command + 4`. -All screenshots taken will be saved to the desktop. - -Each Linux desktop environment has its own screenshot tool. For example, -on KDE Plasma the program Spectacle is used for taking screenshots. If your -distribution doesn't come with one by default try searching its package -repository, or Flathub if that's supported. - -All screenshots should ideally be taken on a 1080p screen. Anything higher -resolution is adding detail that doesn't make the documentation better and -dramatically increases file size. If you're taking screenshots on a higher -resolution screen the screenshot should be scaled down. There are instructions -on how to do this later on this page. - -.. _doc_docs_image_guidelines_format_conversion: - -Format conversion -~~~~~~~~~~~~~~~~~ - -The current format for images in Godot's documentation is WebP (``.webp``). -While some Linux programs will support saving screenshots in this format, macOS -and the Snip & Sketch program on Windows do not. For images that don't need -editing, such as precise cropping or adding outlines, Squoosh can be used. -`Squoosh `_ is a converter developed by Google, is open -source, and doesn't give Google any image rights by using it. When choosing -compression if you can get an image that's under 300KB in size use lossless -compression. If it's over 300KB, use just enough lossy compression to get it -under that size. If this results in noticeable compression artifacts using less -compression is fine, even if the file size is bigger. - -If you already have an image editor such as GIMP, Krita or Photoshop installed -it may have the ability to open an image then save it as a WebP file. - -.. note:: - - Since WebP supports animations and the documentation can display videos, - GIFs should be avoided. Their compression is inefficient and they only support - a 256-color palette with 1-bit transparency. - -.. _doc_docs_image_guidelines_cropping: - -Cropping -~~~~~~~~ - -For a screenshot of a 2D or 3D scene in the editor, the above steps will be enough. -But for most UI images some extra work should be done, specifically cropping to -make an image look clean. Below is an example of good cropping. - -.. image:: img/cropped_image.webp - -For cropping Krita is the recommended program. While some screenshot programs do -have cropping built-in it's not always easy to get something precise. And while -Krita is designed as a painting program the cropping tool gives you pixel precision -by default. Of course, feel free to use a different program you are familiar with. - -If you've never used Krita before download it from the `official Krita website `_, -on Linux you may also be able to download it from your distributions repository, -flathub is also an option. Once it's installed on your computer open Krita then -open the image you want to crop. This button on the left panel is the crop tool. - -.. image:: img/crop_tool.webp - -After selecting it, click on the image, you should now have cropping tools available. - -.. image:: img/crop_edit.webp - -Click and drag the white boxes to adjust what gets cropped, if you zoom in close -to the image you will see the individual pixels in an image, which is useful for -precision. - -.. image:: img/crop_pixels.webp - -If you make a mistake and overcrop don't worry, cropping is non-destructive in -Krita and can be adjusted. Click on the image with your cropping tool still selected -and the controls will return. - -.. _doc_docs_image_guidelines_scaling_down: - -Scaling down an image -~~~~~~~~~~~~~~~~~~~~~ - -As explained earlier on this page, all images taken on a screen that is a higher resolution -than 1080p should be scaled down. To do this in Krita click on **Image** on the top bar, and -from the dropdown menu select **Scale Image To New Size**. This menu can also be opened by -pressing :kbd:`Ctrl + Alt + I`. On this menu you want to adjust the pixel dimensions. For -anything taken on a 4K monitor change the value of the width and height to half of its current -value, for anything taken on a 1440p monitor multiply the width and height by 0.75. Make -sure the **Constrain Proportions** box at the bottom of the menu is checked so you only have -to change 1 value. - -Saving as WebP in Krita -~~~~~~~~~~~~~~~~~~~~~~~ - -To save an image as webp if it isn't already one, Go to **File > Save As**. Select **webp** from the -**Save as type:** dropdown, then choose wherever you want to save it. After clicking **Save** a menu -will popup with webp options. Make sure **Lossless** is checked and **Quality** is set to 100%. This -means the image will not lose detail and will be as small as possible. - -If the image is over 300KB in size try compressing it losslessly using `Squoosh `_. -If it's still over 300KB change to lossy compression and slowly increase the compression until it's under -300KB. If this results in noticeable compression artifacts using less compression is fine, even if the file -size is bigger. - -.. _doc_docs_image_guidelines_outlines: - -Outlines, arrows and text -~~~~~~~~~~~~~~~~~~~~~~~~~ - -Sometimes an image needs something extra to properly direct the readers -attention, or make something clear. Outlines and arrows can be used -for this purpose. For these types of edits Inkscape is the recommended open -source program, it can be downloaded from the `official Inkscape website `_. -Like Krita, if you're on Linux you can also check your distributions repository -or get it from Flathub. - -A full tutorial on creating outlines is not provided here, we recommend searching -for various tutorials on how to use it online. However there are two standards -for doc image outlines and arrows. First, the color should be yellow, specifically -this hex color: ``fffb44`` (``fffb44ff`` if there is a transparency value like in Inkscape). -This color was chosen specifically to make sure color blind people do not have -issues reading the documentation, other colors can be used in addition to this yellow -if multiple outlines on an image are needed, red should be avoided. The second standard -is that all outlines and arrow lines should be 2 pixels wide. - -Finally, some images might require text to differentiate multiple parts of an image. -There are no strict requirements other than use an easy to read non fancy font. As for -color the yellow color from before should also be used, but black or other colors can -be used if appropriate. For example, if yellow blends into the image, or if there are -multiple outlines in multiple colors. - -Adding an image to a documentation page -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Once you've finished working on your image, it can be added to the documentation. -All images are stored in folders named ``img`` next to the page they are used in. - -To add your image, add it to the ``img`` folder that's in the same folder as the -``.rst`` file for the page (create it if it doesn't exist). In the ``.rst`` page, -images should be included with the following code snippet: - -:: - - .. image:: img/documentation_image.webp - -Where ``documentation_image.webp`` would be changed to the name of the image you -created. Name your images in a way that makes their meaning clear, possibly with -a prefix that makes their relationship to a documentation page explicit. - -.. _doc_docs_image_guidelines_videos: - -Videos ------- - -Capturing a video -~~~~~~~~~~~~~~~~~ - -To record a video of something in Godot, a screen capture tool can be used. -Operating systems generally don't come with tools that are flexible enough -for this, so you'll need to install a third-party utility. - -`OBS Studio `__ is the most popular option, but -`SimpleScreenRecorder `__ -can be used as an alternative on Linux. `ShareX `__ -can be used as an alternative on Windows. All these tools can be configured -to record the entire screen, a specific window or a predetermined rectangle. - -The recommended framerate for video recordings is 60 FPS, although you can use -30 FPS for longer videos to reduce their file size. For fullscreen videos, -use a resolution of 1280×720. - -.. note:: - - Godot's :ref:`Movie Maker mode ` can be used to record - the output of a running project, including its audio. This doesn't require - installing any third-party software and avoids any frame drops (even when - recording on a slow device), but it's less flexible. - -Compressing the captured video -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The recommendation is to record your video in the highest quality possible -(without dropping frames due to excessive CPU/GPU utilization), then re-encode -it later to reduce its file size. This results in more efficient compression -than directly aiming for a small file size, as real-time compression methods are -less efficient than slower compression methods. - -To re-encode videos for a smaller file size, use `HandBrake `__ -or the `FFmpeg ` command line below: - -:: - - ffmpeg -i input.mp4 -crf 23 output.webm - -The number after ``-crf`` adjusts the video quality, with higher numbers -resulting in *lower* quality (and smaller file sizes). A CRF of ``23`` is a good -starting point, but you may need to use a higher value for longer videos to -ensure the file size remains reasonable. Try to aim for a file size under 2 MB -if possible. - -If the video was recorded in a higher resolution or framerate, you can adjust -its output resolution and framerate as follows: - -:: - - ffmpeg -i input.mp4 -crf 23 -vf scale=1280:-2 -r 30 output.webm - -This results in a video resolution around 1280×720 at 30 FPS. The exact -video resolution will vary depending on the source's aspect ratio. - -.. tip:: - - If the video was recorded with an audio track but this audio track is not - necessary, consider stripping it by adding the ``-an`` option to the FFmpeg - command line (before the output file name). This will reduce file size and - also ensure audio controls don't show up on the video when played in a - browser. - -Adding a video to a documentation page --------------------------------------- - -Once you've finished working on your video, it can be added to the documentation. -All videos are stored in folders named ``video`` next to the page they are used in. - -To add your video, add it to the ``video`` folder that's in the same folder as the -``.rst`` file for the page (create it if it doesn't exist). In the ``.rst`` page, -videos should be included with the following code snippet: - -:: - - .. video:: video/csg_tools.webm - :alt: Put a text description of the video here - :autoplay: - :loop: - :muted: - :align: default - -Where ``documentation_video.webp`` would be changed to the name of the video you -created. Name your videos in a way that makes their meaning clear, possibly with -a prefix that makes their relationship to a documentation page explicit. - -The ``:autoplay:``, ``:loop:`` and ``:muted:`` flags should always be specified -unless the video needs to play audio. In this case, do not specify *any* of these flags. -The ``:align: default`` flag should always be specified. diff --git a/contributing/documentation/docs_writing_guidelines.rst b/contributing/documentation/docs_writing_guidelines.rst deleted file mode 100644 index 1defda268..000000000 --- a/contributing/documentation/docs_writing_guidelines.rst +++ /dev/null @@ -1,917 +0,0 @@ -.. _doc_docs_writing_guidelines: - -Writing guidelines -================== - -The Godot community is rich and international. Users come from all -around the world. Some of them are young, and many aren't native English -speakers. That's why we must all write using a clear and a common -language. For the class reference, the goal is to make it easy to read -for everyone and precise. - -In summary, always try to: - -1. Use the active voice -2. Use precise action verbs -3. Avoid verbs that end in -ing -4. Remove unnecessary adverbs and adjectives. -5. Ban these 8 words: obvious, simple, basic, easy, actual, just, clear, and however -6. Use explicit references -7. Use 's to show possession -8. Use the Oxford comma - -There are 3 rules to describe classes: - -1. Give an overview of the node in the brief description -2. Mention what methods return if it's useful -3. Use "if true" to describe booleans - -.. note:: - - A technical writer's job is to pack as much information as possible into - the smallest and clearest sentences possible. These guidelines will help - you work towards that goal. - -.. seealso:: - - See the :ref:`content guidelines ` for information - on the types of documentation you can write in the official documentation. - -.. _doc_docs_writing_guidelines_clear_english_rules: - -7 rules for clear English -------------------------- - -Use the active voice -~~~~~~~~~~~~~~~~~~~~ - -Use the active voice when possible. Take the classes, methods, and -constants you describe as the subject. It's natural to write using the -passive voice, but it's harder to read and produces longer sentences. - -.. highlight:: none - -Passive: - -:: - - The man **was bitten** by the dog. - -Active: - -:: - - The dog bit the man. - -**Don't** use the passive voice: - -:: - - void edit_set_pivot ( Vector2 pivot ) - [...] This method **is implemented** only in some nodes that inherit Node2D. - -**Do** use the node's name as a noun: - -:: - - void edit_set_pivot ( Vector2 pivot ) - [...] Only some Node2Ds **implement** this method. - -Use precise action verbs -~~~~~~~~~~~~~~~~~~~~~~~~ - -Favor precise yet common verbs over generic ones like ``make``, ``set``, -and any expression you can replace with a single word. - -**Don't** repeat the method's name. It already states it sets the pivot -value to a new one: - -:: - - void edit_set_pivot ( Vector2 pivot ) - Set the pivot position of the 2D node to [code]pivot[/code] value. [...] - -**Do** explain what's the consequence of this "set": use precise verbs -like ``place``, ``position``, ``rotate``, ``fade``, etc. - -:: - - void edit_set_pivot ( Vector2 pivot ) - Position the node's pivot to the [code]pivot[/code] value. [...] - -Avoid verbs that end in -ing -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The progressive forms describe continuous actions. E.g. "is calling", -"is moving". - -**Don't** use the progressive form for instant changes. - -:: - - Vector2 move ( Vector2 rel_vec ) - Move the body in the given direction, **stopping** if there is an obstacle. [...] - -**Do** use simple present, past, or future. - -:: - - Vector2 move ( Vector2 rel_vec ) - Moves the body in the vector's direction. The body **stops** if it collides with an obstacle. [...] - -Exception: If the subject is not clear, replacing "ing" verbs is not an -improvement. For example, in the previous sentence, "it replaces" -would not make much sense where "replacing" currently is. - -You may use the progressive tense to describe actions that are -continuous in time. Anything like animation or coroutines. - -.. tip:: - - Verbs can turn into adjectival nouns with -ing. This is not a - conjugation, so you may use them: ``the remaining movement``, - ``the missing file``, etc. - -Remove unnecessary adverbs and adjectives -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Write as few adjectives and adverbs as possible. Only use them if they -add key information to the description. - -**Don't** use redundant or meaningless adverbs. Words that lengthen the -documentation but don't add any information: - -:: - - **Basically** a big texture [...] - -**Do** write short sentences in a simple, descriptive language: - -:: - - A big texture [...] - -Ban these 8 words -~~~~~~~~~~~~~~~~~ - -**Don't** ever use these 8 banned words: - -1. obvious -2. simple -3. basic -4. easy -5. actual -6. just -7. clear -8. however (some uses) - -Game creation and programming aren't simple, and nothing's easy to -someone learning to use the API for the first time. Other words in the -list, like ``just`` or ``actual`` won't add any info to the sentence. -Don't use corresponding adverbs either: obviously, simply, basically, -easily, actually, clearly. - -**Don't** example. The banned words lengthen the description and take -attention away from the most important info: - -:: - - **TextureRect** - Control frame that **simply** draws an assigned texture. It can stretch or not. It's a **simple** way to **just** show an image in a UI. - -**Do** remove them: - -:: - - **TextureRect** - [Control] node that displays a texture. The texture can stretch to the node's bounding box or stay in the center. Useful to display sprites in your UIs. - -"Simple" never helps. Remember, for other users, anything could be -complex or frustrate them. There's nothing like a good old *it's simple* -to make you cringe. Here's the old brief description, the first sentence -on the Timer node's page: - -:: - - **Timer** - A **simple** Timer node. - -**Do** explain what the node does instead: - -:: - - **Timer** - Calls a function of your choice after a certain duration. - -**Don't** use "basic", it is too vague: - -:: - - **Vector3** - Vector class, which performs **basic** 3D vector math operations. - -**Do** use the brief description to offer an overview of the node: - -:: - - **Vector3** - Provides essential math functions to manipulate 3D vectors: cross product, normalize, rotate, etc. - -Use explicit references -~~~~~~~~~~~~~~~~~~~~~~~ - -Favor explicit references over implicit ones. - -**Don't** use words like "the former", "the latter", etc. They're not -the most common in English, and they require you to check the reference. - -:: - - [code]w[/code] and [code]h[/code] define right and bottom margins. The **latter** two resize the texture so it fits in the defined margin. - -**Do** repeat words. They remove all ambiguity: - -:: - - [code]w[/code] and [code]h[/code] define right and bottom margins. **[code]w[/code] and [code]h[/code]** resize the texture so it fits the margin. - -If you need to repeat the same variable name 3 or 4 times, you probably -need to rephrase your description. - -Use 's to show possession -~~~~~~~~~~~~~~~~~~~~~~~~~ - -Avoid "The milk **of** the cow". It feels unnatural in English. Write "The cow's -milk" instead. - -**Don't** write "of the X": - -:: - - The region **of the AtlasTexture that is** used. - -**Do** use ``'s``. It lets you put the main subject at the start of the -sentence, and keep it short: - -:: - - The **AtlasTexture's** used region. - -Use the Oxford comma to enumerate anything -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -From the Oxford dictionary: - - The 'Oxford comma' is an optional comma before the word 'and' at the end of a list: - *We sell books, videos, and magazines.* - - [...] Not all writers and publishers use it, but it can clarify the meaning of a sentence when the items in a list are not single words: - *These items are available in black and white, red and yellow, and blue and green.* - -**Don't** leave the last element of a list without a comma: - -:: - - Create a CharacterBody2D node, a CollisionShape2D node and a sprite node. - -**Do** add a comma before `and` or `or`, for the last -element of a list with more than two elements. - -:: - - Create a CharacterBody2D node, a CollisionShape2D node, and a sprite node. - - -How to write methods and classes --------------------------------- - -.. _doc_docs_writing_guidelines_dynamic_typing: - -Dynamic vs static typing -~~~~~~~~~~~~~~~~~~~~~~~~ - -The code examples in the documentation should follow a consistent style not to -confuse users. As static type hints are an optional feature of GDScript, we -chose to stick to writing dynamic code. This leads to writing GDScript that is -concise and accessible. - -The exception is topics that explain static typing concepts to users. - -**Don't** add a type hint with a colon or by casting: - -:: - - const MainAttack := preload("res://fire_attack.gd") - var hit_points := 5 - var name: String = "Bob" - var body_sprite := $Sprite2D as Sprite2D - - -**Do** write constants and variables with dynamic typing: - -:: - - const MainAttack = preload("res://fire_attack.gd") - var hit_points = 5 - var name = "Bob" - var body_sprite = $Sprite2D - - -**Don't** write functions with inferred arguments or return types: - -:: - - func choose(arguments: PackedStringArray) -> String: - # Chooses one of the arguments from array with equal chances - randomize() - var size := arguments.size() - var choice: int = randi() % size - return arguments[choice] - -**Do** write functions using dynamic typing: - -:: - - func choose(arguments): - # Chooses one of the arguments from array with equal chances - randomize() - var size = arguments.size() - var choice = randi() % size - return arguments[choice] - -.. _doc_docs_writing_guidelines_real_world_code_example: - -Use real-world code examples where appropriate -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Real-world examples are more accessible to beginners than abstract ``foos`` and -``bars``. You can also copy them directly from your game projects, ensuring that -any code snippet compiles without errors. - -Writing ``var speed = 10`` rather than ``var my_var = 10`` allows beginners to -understand code better. It gives them a frame of reference as to where they -could use the code snippets in a live project. - -**Don't** write made-up examples: - -.. code-block:: gdscript - - @onready var a = preload("res://MyPath") - @onready var my_node = $MyNode - - - func foo(): - # Do stuff - -**Do** write concrete examples: - -.. code-block:: gdscript - - @onready var sfx_player_gun = preload("res://Assets/Sound/SFXPlayerGun.ogg") - @onready var audio_player = $Audio/AudioStreamPlayer - - - func play_shooting_sound(): - audio_player.stream = sfx_player_gun - audio_player.play() - -Of course, there are times when using real-world examples is impractical. In -those situations, you should still avoid using names such as ``my_var``, -``foo()`` or ``my_func()`` and consider more meaningful names for your examples. - -Give an overview of the node in the brief description -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The brief description is the reference's most important sentence. It's -the user's first contact with a node: - -1. It's the only description in the "Create New Node" dialog. -2. It's at the top of every page in the reference - -The brief description should explain the node's role and its -functionality, in up to 200 characters. - -**Don't** write tiny and vague summaries: - -:: - - **Node2D** - Base node for 2D system. - -**Do** give an overview of the node's functionality: - -:: - - **Node2D** - A 2D game object, inherited by all 2D-related nodes. Has a position, rotation, scale, and Z index. - -Use the node's full description to provide more information, and a code -example, if possible. - -Mention what methods return if it's useful -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Some methods return important values. Describe them at the end of the -description, ideally on a new line. No need to mention the return values -for any method whose name starts with ``set`` or ``get``. - -**Don't** use the passive voice: - -:: - - Vector2 move ( Vector2 rel_vec ) - [...] The returned vector is how much movement was remaining before being stopped. - -**Do** always use "Returns". - -:: - - Vector2 move ( Vector2 rel_vec ) - [...] Returns the remaining movement before the body was stopped. - -Notice the exception to the "direct voice" rule: with the move method, -an external collider can influence the method and the body that calls -``move``. In this case, you can use the passive voice. - -Use "if true" to describe booleans -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -For boolean member variables, always use ``if true`` and/or -``if false``, to stay explicit. ``Controls whether or not`` may be -ambiguous and won't work for every member variable. - -Also, surround boolean values, variable names and methods with ``[code][/code]``. - -**Do** start with "if true": - -:: - - Timer.autostart - If [code]true[/code], the timer will automatically start when entering the scene tree. - - -Use ``[code]`` around arguments -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -In the class reference, always surround arguments with ``[code][/code]``. In the -documentation and in Godot, it will display like ``this``. When you edit XML -files in the Godot repository, replace existing arguments written like 'this' or -\`this\` with ``[code]this[/code]``. - -.. _doc_docs_writing_guidelines_common_vocabulary: - -Common vocabulary to use in Godot's documentation -------------------------------------------------- - -The developers chose some specific words to refer to areas of the -interface. They're used in the sources, in the documentation, and you -should always use them instead of synonyms, so the users know what -you're talking about. - -.. figure:: img/editor-vocabulary-overview.png - :alt: Overview of the interface and common vocabulary - - Overview of the interface and common vocabulary - -In the top left corner of the editor lie the ``main menus``. In the -center, the buttons change the ``workspace``. And together the buttons -in the top right are the ``playtest buttons``. The area in the center, -that displays the 2D or the 3D space, is the ``viewport``. At its top, -you find a list of ``tools`` inside the ``toolbar``. - -The tabs or dockable panels on either side of the viewport are -``docks``. You have the ``FileSystem dock``, the ``Scene dock`` that -contains your scene tree, the ``Import dock``, the ``Node dock``, and -the ``Inspector`` or ``Inspector dock``. With the default layout you may -call the tabbed docks ``tabs``: the ``Scene tab``, the ``Node tab``... - -The Animation, Debugger, etc. at the bottom of the viewport are -``panels``. Together they make up the ``bottom panels``. - -Foldable areas of the Inspector are ``sections``. The node's parent -class names, which you can't fold, are ``Classes`` e.g. the -``CharacterBody2D class``. And individual lines with key-value pairs are -``properties``. E.g. ``position`` or ``modulate color`` are both -``properties``. - -.. _doc_docs_writing_guidelines_keyboard_shortcuts: - -Keyboard shortcut guidelines ----------------------------- - -Keyboard and mouse shortcuts should make use of the ``:kbd:`` tag, which allows -shortcuts to stand out from the rest of the text and inline code. Use the -compact form for modifier keys (:kbd:`Ctrl`/:kbd:`Cmd`) instead of their spelled -out form (:kbd:`Control`/:kbd:`Command`). For combinations, use the ``+`` symbol -with a space on either side of the symbol. - -Make sure to mention shortcuts that differ on macOS compared to other platforms. -You can find a list of all shortcuts, including what they are on macOS, on -:ref:`this page `. - -Try to integrate the shortcut into sentences the best you can. Here are some -examples with the ``:kbd:`` tag left as-is for better visibility: - -- Press ``:kbd:`Ctrl + Alt + T``` to toggle the panel (``:kbd:`Opt + Cmd + T``` on macOS). -- Press ``:kbd:`Space``` and hold the left mouse button to pan in the 2D editor. -- Press ``:kbd:`Shift + Up Arrow``` to move the node upwards by 8 pixels. - -.. _doc_docs_writing_guidelines_manual_style: - -Manual style guidelines ------------------------ - -Follow these formatting and style guidelines when writing the manual. - -Use your best judgement. If you can write more clearly by breaking one of these -guidelines, please do! But remember that the guidelines exist for a reason. - -.. note:: In many cases, the manual does not follow these guidelines. If you are - already making changes to a paragraph or section of the docs, update it to - follow these standards. Avoid making unrelated changes that *only* update style, - since every change will require the paragraph to be re-translated. - -Text styles -~~~~~~~~~~~ - -There are a few styles that the manual uses. - -+---------------------+--------------------------+------------------------------------------------------------------------+ -| Style | RST formatting | Typical usage | -+=====================+==========================+========================================================================+ -| Plaintext | ``text`` | Used for most text. | -+---------------------+--------------------------+------------------------------------------------------------------------+ -| *Italics* | ``*text*`` | Used for emphasis. Used for introducing new terms. | -+---------------------+--------------------------+------------------------------------------------------------------------+ -| **Bold** | ``**text**`` | Used for emphasis, and for editor UI like menus and windows. | -| | | | -+---------------------+--------------------------+------------------------------------------------------------------------+ -| ``Code`` | `` text `` | Used for variable names, literal values, and code snippets. ``code`` is| -| | | used in many cases where you would use "quoted plaintext" in typical | -| | | English. | -+---------------------+--------------------------+------------------------------------------------------------------------+ -| "Quotes" | ``"text"`` | Used for some literal or quoted values. In many cases, another | -| | | style is preferred. | -+---------------------+--------------------------+------------------------------------------------------------------------+ - -Emphasis -~~~~~~~~ - -Use either **bold style** or *italic style* to emphasize words or sentences. -In most cases, either **bold** or *italics* is fine. Use whichever seems best, -or whatever the page already uses. - -Prefer using **bold style** for simple emphasis. - - - Do **not** close the window without saving first. - -Use *italic style* or to emphasize one word in the context of a sentence. - - - You can *add* a node to the scene (but you can't connect one). - - You can add a *node* to the scene (but you can't add a resource). - - You can add a node to the *scene* (but you can't add one to a resource). - -Use *italic style* when introducing new technical terms. **Bold style** -is fine too. - - - Godot uses *nodes* with *scripts* in a *scene tree*. - - Godot uses **nodes** with **scripts** in a **scene tree**. - -.. _doc_docs_writing_guidelines_literals: - -Literals -~~~~~~~~ - -Use ``code style`` for literal values. Literals include: - - - Integer or ``int`` literals like ``0``, ``-2``, or ``100`` - - Float literals like ``0.0``, ``0.5``, ``-2.0``, or ``100.0`` - - Vector literals like ``(0.0, 0.0)``, ``(0.5, -0.5, 0.5)``, or ``(1.0, 2.0, 3.0, 4.0)``. - -.. _doc_docs_writing_guidelines_class_properties_methods: - -Classes, properties, and methods -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Link to classes the first time that you mention them in a page. After the first -mention, use ``code style``. For common classes, like ``Node``, ``Control``, or -``Viewport``, you can also use plaintext. - -Link to class members (properties, methods, enums, and constants) the first time -that you mention them in a page. After the first mention, use ``code style``. If -the class member is very common, like a Node2D's ``position``, you don't have to -link. - -When discussing properties in the context of the inspector, use **bold style** -instead. - -.. _doc_docs_writing_guidelines_editor_ui: - -Editor UI -~~~~~~~~~ - -Use **bold style** for editor UI, including window titles, menus, buttons, input -fields, inspector properties, and inspector sections. Use the exact -capitalization that the editor uses. - - - Open the **Editor Settings** window. - - Press the **Confirm** button. - - Change the node's **Transform > Position** property to ``(0, 0)``. - - In the **Project Settings** window, enable the **Advanced Settings** toggle. - -Use **Bold > With > Separators** when describing sequence of menus that the -reader must navigate. Use ``>`` as a separator. You can omit ellipses in menu names. - - - In **Project > Project Settings > Input Map**, add a new input action. - - Select **Scene > Export As... > MeshLibrary...**. - - Select **Scene > Export As > MeshLibrary**. - -.. note:: Sometimes, ``->`` or ``→`` is used as a separator. This is nonstandard. - Replace it with ``>`` if you are already making changes to a section. - -.. _doc_docs_writing_guidelines_project_settings: - -Project settings -~~~~~~~~~~~~~~~~ - -Link to individual project settings. Either include the section and subsection -in the link itself, or include the section and subsection separately from the -link. Since long links are not split into multiple lines when the page is -rendered, prefer splitting the setting name and the section when the link is long. - - - Set the :ref:`Application > Run > Max FPS` setting to ``60``. - - In the project settings under **Application > Run**, set :ref:`Max FPS` to ``60``. - - In **Project Settings > Application > Run**, set :ref:`Max FPS` to ``60``. - -Code blocks and adominitions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Code blocks should use the ``::`` syntax on its own line. Do not use the short -form where it's at the end of a paragraph, as the trailing ``::`` would be included -in the localizable string otherwise. Weblate would show a warning due to the trailing ``::``, -and if the localized string does not end with ``::``, it would break the code block entirely -in the translated manual. - - -**Bad:** - -:: - - This is a code block:: - - The code block's contents. - -**Good:** - -:: - - This is a code block: - - :: - - The code block's contents. - -As for admonitions (note, warning, etc. blocks), you should write the admonition tag on its own line, -then the admonition's contents indented by 4 spaces. Do not write the first line of the contents -on the same line as the admonition tag. - -**Bad:** - -:: - - This is an admonition: - - .. note:: First line of the note's contents. - Second line of the note's contents. - -**Good:** - -:: - - This is an admonition: - - .. note:: - - First line of the note's contents. - Second line of the note's contents. - -.. _doc_docs_writing_guidelines_manually_wrapping_lines: - -Manually wrapping lines -~~~~~~~~~~~~~~~~~~~~~~~ - -In the manual, lines must be manually wrapped to no more than 80-100 characters -per line. However, links must not be split into multiple lines, and can exceed -100 characters. Tables can also exceed 100 characters. - -When making small changes, you don't need to manually re-wrap the whole paragraph, -as long as the lines don't exceed 100 characters. - -**Bad:** Line length exceeds 100 characters: - -.. code-block:: - - The best thing to do is to wrap lines to under 80 characters per line. Wrapping to around 80-90 characters per line is also fine. - If your lines exceed 100 characters, you definitely need to add a newline! Don't forget to remove trailing whitespace when you do. - -**Good:** Lines are wrapped to 80-90 characters: - -.. code-block:: - - The best thing to do is to wrap lines to under 80 characters per line. Wrapping to - around 80-90 characters per line is also fine. If your lines exceed 100 characters, you - definitely need to add a newline! Don't forget to remove trailing whitespace when you do. - -**Best:** Lines are wrapped to under 80 characters: - -.. code-block:: - - The best thing to do is to wrap lines to under 80 characters per line. Wrapping - to around 80-90 characters per line is also fine. If your lines exceed 100 - characters, you definitely need to add a newline! Don't forget to remove - trailing whitespace when you do. - -.. tip:: In most text editors, you can add a vertical guide or "ruler" at 80 - characters. For example, in Visual Studio Code, you can add the following to - your ``settings.json`` to add rulers at 80 and 100 characters: - - .. code:: json - - "editor.rulers": [80,100], - -Section header syntax -~~~~~~~~~~~~~~~~~~~~~ - -Use the following syntax for section headers: - -.. code-block:: - - Page title - ========== - - Renders as h1. - Every page has this. - - Section header - -------------- - - Renders as h2. - Usually appears in sidebar. Many pages only need one level of nested headers. - - Sub-section header - ~~~~~~~~~~~~~~~~~~ - - Renders as h3. - Appears in sidebar in some pages, depending on how deeply nested the page is. - - Sub-sub-section header - ^^^^^^^^^^^^^^^^^^^^^^ - - Renders as h4. - Usually won't appear in the sidebar. - -Currently, there are no cases of deeper header nesting than this. Avoid -introducing any deeper nesting. - -Note that headers have no inherent meaning. In reStructuredText, headers are -parsed based on the order that they initially appear within a page. Make sure -that if you use an ``h3`` section header (``~~~``), you include an ``h2`` -sub-section header (``---``) first. - -See the `Sphinx documentation `__ -and the `reStructuredText documentation `__ -for more information. - -.. _doc_docs_writing_guidelines_specific_version: - -When to refer to a specific Godot version ------------------------------------------ - -Most of the time, the class reference and the manual should not specify the first -version in which a feature is added. This is because the documentation describes -the *current* features of the engine. Documentation will be read and maintained -for many versions after it is initially written, and a reference to a first supported -version is only relevant for a few versions after a feature is added. After that, -it becomes historical trivia best left to a dedicated changelog. - -Follow these guidelines for when to refer to a specific Godot version: - -- If a feature was added in the current major version (4.x), **you can specify** - the feature is new in 4.x. -- If a feature or default approach to a problem was changed between major versions - (3.x -> 4.x), describe the current feature in the main body of the page, and - optionally add a brief sentence or note block to compare 3.x and 4.x. -- If a large feature is added in a 4.x minor version, **you can specify** the minor - version when it was added. Large features have a whole page or large section of - documentation. In many cases it should still be avoided, since it's only relevant - for the next few minor versions. -- If a small feature is added in a 4.x minor version, **do not specify** the minor - version when it was added. Small features have only a short section of - documentation, or are minor additions to existing features. -- If the default approach to a problem is changed in a 4.x minor version, **do - specify** the minor version in which a new default approach was added. For example, - the change from ``TileMap`` to ``TileMapLayer`` in 4.3. -- If a feature was added in a 3.x major or minor version, **do not specify** when - the feature was added. These features are old enough that the exact version - in which they were added is not relevant. - -Use roles for editor UI ------------------------ - -Much of the manual involves describing a sequence of UI actions in the editor, -like clicking a button, opening a menu, or setting a property in the inspector. -To keep formatting standardized, we use custom Sphinx roles for UI elements. - -The following roles are defined: - -- ``:button:`` A button, toggle, or other clickable UI element. If the reader - is meant to click on it, and it's not a menu, use this. Renders as - :button:`bold, with a background`. -- ``:menu:`` A series of menus to click through. When listing a series of - menus, separate them with ``>``. Renders as :menu:`bold, with a background`. -- ``:inspector:`` A property *in the inspector*. When describing a property in - *code*, instead either use ``code style`` or link to the property, as - described earlier. Renders as :inspector:`bold`. -- ``:ui:`` A role for any other editor UI elements. Use this if you would have - otherwise just used **bold style**. Use this for input fields, docks, tabs, - windows, bottom panels, etc. Also used for nested project settings or - inspector sections. Renders as :ui:`bold`. - -The first two roles, ``:button:`` and ``:menu:`` are used for editor UI that the -reader is meant to click on, and they use an attention-grabbing visual style. The -other roles, ``:inspector:`` and ``:ui:``, are used for other UI and show up -often in text, so they just use bold text to be less distracting. - -Our custom roles are inspired by the Sphinx `guilabel `_ -and `menuselection `_ -roles. However, we use our own implementation to better match the specific needs -of Godot's documentation, using `custom RST roles `_ -and some custom CSS. - -Examples -~~~~~~~~ - -These are some example sections that use the roles, in context. Check the source -of this page to see which roles are used. - -Adding a sprite and setting some properties -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -In the :ui:`Scene` dock, click :button:`2D Scene` to create a new scene. - -Add a new :ref:`Sprite2D ` to the scene by right-clicking on the -root node and choosing :button:`Add Child Node...`. In the :ui:`Create New Node` -window, search for "Sprite2D", select it, and then click :button:`Create`. - -On the sprite, under :ui:`Offset`, set :inspector:`Offset` to ``(16, 32)`` -and enable :inspector:`Flip H`. Set :inspector:`Animation > HFrames` to ``10``. -In :ui:`CanvasItem > Visibility`, set the :inspector:`Modulate` color to -``ff0000``. - -.. tip:: - - Don't forget to save your scene in :menu:`Scene > Save Scene...`. When the - :ui:`Save Scene As...` window pops up, enter "my_scene.tscn" in the - :ui:`File` field, then click :button:`Save`. - -Setting project settings -^^^^^^^^^^^^^^^^^^^^^^^^ - -Go to :menu:`Project > Project Settings`, then select the -:ref:`Max FPS ` -setting under :ui:`Application > Run`. Don't forget to click the -:button:`Advanced Settings` toggle. Then, in :ui:`Filter Settings`, search for -"physics". Under :ui:`Physics > 3D > Solver`, set -:inspector:`Solver Iterations` to ``16``. - -All styles in context -^^^^^^^^^^^^^^^^^^^^^ - -Use this section to see how the custom roles look, particularly within admonitions. - -|styleroles| - -.. note:: - - |styleroles| - -.. warning:: - - |styleroles| - -.. danger:: - - |styleroles| - -.. tip:: - - |styleroles| - -.. admonition:: Custom admonition - - |styleroles| - -.. All the inline roles which are used in the docs. External links don't work in a substitution. -.. |styleroles| replace:: Built-in styles: ``code``, **bold**, and *italics*. - Built-in roles: :kbd:`kbd`, :ref:`ref `, :ref:`ref `. - Custom roles: :button:`button`, :menu:`menu > submenu`, :inspector:`inspector`, :ui:`ui`. diff --git a/contributing/documentation/editor_and_docs_localization.rst b/contributing/documentation/editor_and_docs_localization.rst deleted file mode 100644 index cf1264afc..000000000 --- a/contributing/documentation/editor_and_docs_localization.rst +++ /dev/null @@ -1,422 +0,0 @@ -.. _doc_editor_and_docs_localization: - -Editor and documentation localization -===================================== - -.. highlight:: none - -Godot aims to make game development available to everyone, including people who -may not know or be comfortable with English. Therefore, we do our best to make -the most important resources available in many languages, thanks to the -translation effort of the community. - -These resources include: - -1. The `Godot editor's interface `__. -2. The `class reference `__, - available both online and in the editor. -3. The `online documentation `__ - (editor manual and tutorials). - -To manage translations, we use the GNU gettext file format (``PO`` files), and -the open source `Weblate `__ web-based localization -platform, which allows easy collaboration of many contributors to complete the -translation for the various components, and keep them up to date. Click the bold -links above to access each resource on Weblate. - -This page gives an overview of the general translation workflow on Weblate, and -some resource-specific instructions on e.g. how to handle some keywords or the -localization of images. - -.. tip:: - - Translating all the official Godot content is a massive undertaking, so we - advise prioritizing the resources as they are listed above: first the editor - interface, then the class reference, then the online documentation. - -Using Weblate for translations ------------------------------- - -While our translations eventually reside in the Git repositories of the Godot -engine and its documentation, all translation updates are handled through -Weblate, and thus direct pull requests to the Git repositories are not accepted. -Translations are synced manually between Weblate and the Godot repositories by -maintainers. - -You should therefore `register on Weblate `__ -to contribute to Godot's translations. - -Once signed in, browse to the Godot resource which you want to contribute to (in -this page we will use the `editor translation `__ -as an example) to find the list of all languages: - -.. image:: img/l10n_01_language_list.png - -.. seealso:: - - Feel free to consult Weblate's own documentation on the `translation - workflow `__ for - more details. - -Adding a new language -~~~~~~~~~~~~~~~~~~~~~ - -If your language is already listed, click on its name to access the overview, -and skip the rest of this section. - -If your language is not listed, scroll to the bottom of the list of languages -and click the "Start new translation" button, and select the language you want -to translate to: - -.. image:: img/l10n_02_new_translation.png - -.. important:: - - If your language is spoken in several countries with only limited regional - variations, please consider adding it with its generic variant (e.g. ``fr`` - for French) instead of a regional variant (e.g. ``fr_FR`` for French - (France), ``fr_CA`` for French (Canada), or ``fr_DZ`` for French (Algeria)). - - Godot has a huge amount of content to translate, so duplicating the work for - regional variants should only be done if the language variations are - significant enough. Additionally, if a translation is done with for a - regional variant, it will only be available automatically for users located - in this region (or having their system language configured for this region). - - When regional variations are significant enough to warrant separate - translations, we advise to focus on completing a generic variant first if - possible, then duplicate the fully completed translation for regional - variants and do the relevant edits. This is typically a good strategy for - e.g. Spanish (work on ``es`` first, then duplicate it to ``es_AR``, - ``es_ES``, ``es_MX``, etc. if necessary) or Portuguese (``pt_BR`` vs - ``pt_PT``). - -Translation interface -~~~~~~~~~~~~~~~~~~~~~ - -Once a language has been selected, you will see an overview of the translation -status, including how many strings are left to translate or review. Each item -can be clicked and used to browse through the corresponding list. You can also -click the "Translate" button to get started on the list of strings needing -action. - -.. image:: img/l10n_03_translation_overview.png - -After selecting a list of clicking "Translate", you will see the main -translation interface where all the work happens: - -.. image:: img/l10n_04_translation_interface.png - -On that page, you have: - - - A toolbar which lets you cycle through strings of the current list, change - to another predefined list or do a custom search, etc. There is also a "Zen" - editing mode with a simplified interface. - - The actual string you are working on in the "Translation" panel. By default, - there should be the English source string and an edit box for your language. - If you are familiar with other languages, you can add them in your user - settings to give you more context for translation. - Once you are done editing the current string, press "Save" to confirm changes - and move to the next entry. Alternatively, use the "Skip" button to skip it. - The "Needs editing" checkbox means that the original string was updated, and - the translation therefore needs review to take those changes into account (in - PO jargon, these are so-called "fuzzy" strings). Such strings won't be used - in the translation until fixed. - - The bottom panel has various tools which can help with the translation - effort, such as context from nearby strings (usually from the same editor - tool or documentation page, so they might use similar terms), comments from - other translators, machine translations, and a list of all other existing - translations for that string. - - On the top right, the glossary shows terms for which an entry has been added - previously, and which are included in the current string. For example, if - you decided with fellow translators to use a specific translation for the - "node" term in Godot, you can add it to the glossary to ensure that other - translators use the same convention. - - The bottom right panel includes information on the source string. The most - relevant item is the "source string location", which links you to the - original string on GitHub. You may need to search for the string in the page - to locate it and its surrounding context. - -Locating original content -------------------------- - -PO files are an ordered list of source strings (``msgid``) and their translation -(``msgstr``), and by default, Weblate will present the strings in that order. It -can therefore be useful to understand how the content is organized in the PO -files to help you locate the original content and use it as a reference when -translating. - -.. important:: - - It is primordial to use the original context as reference when translating, - as many words have several possible translations depending on the context. - Using the wrong translation can actually be detrimental to the user and make - things harder to understand than if they stayed in English. - Using the context also makes the translation effort much easier and more - enjoyable, as you can see directly if the translation you wrote will make - sense in context. - -- The editor interface's translation template is generated by parsing all the - C++ source code in **alphabetical order**, so all the strings defined in a - given file will be grouped together. For example, if the "source string - location" indicates ``editor/code_editor.cpp``, the current string (and the - nearby ones) is defined in the ``editor/code_editor.cpp`` code file, and is - thereby related to the code editors in Godot (GDScript, shaders). -- The online documentation's translation template is generated from the source - RST files in the same order as seen in the **table of contents**, so for - example the first strings are from the front page of the documentation. - The recommended workflow is therefore to find a unique string corresponding to - a page that you want to translate, and then translate all the strings with the - same source string location while comparing with the online version of that - page in English. An example of source string location could be - ``getting_started/step_by_step/nodes_and_scenes.rst`` for the - page :ref:`doc_nodes_and_scenes`. -- The class reference's translation template is generated from the source XML - files in **alphabetical order**, which is also the same as the order of the - table of contents for the online version. You can therefore locate the source - string corresponding to the brief description of a given class to find the - first string to translate and all other descriptions from that class should be - in the subsequent strings on Weblate. For example, the descriptions for the - :ref:`class_Node2D` class would have the source string location - ``doc/classes/Node2D.xml``. - -A handy tool to locate specific pages/classes is to use Weblate's advanced -search feature, and especially the "Location strings" query (which can also be -used with the ``location:`` token, e.g. ``location:nodes_and_scenes.rst``): - -.. image:: img/l10n_05_search_location.png - -.. image:: img/l10n_06_browse_by_location.png - -.. note:: - - When a given source string is used in multiple source locations, they will - all be concatenated into one. For example, the above - ``location:nodes_and_scenes.rst`` query would land first on the - "Introduction" source string which is used in dozens of pages, including - some that come before ``nodes_and_scenes.rst`` in the template. Clicking the - "Next" button then brings us to the "Scene and nodes" title string displayed - above. - So it may happen that a given paragraph or section title is not at the - location you'd expect it when reading the online version of a page. - -Respecting the markup syntax ----------------------------- - -Each translation resource originates from a different source code format, and -having some notions on the markup language used for each resource is important -to avoid creating syntax errors in your translations. - -Editor interface (C++) -~~~~~~~~~~~~~~~~~~~~~~ - -The editor translations originate from C++ strings, and may use: - -- **C format specifiers** such as ``%s`` (a string) or ``%d`` (a number). These - specifiers are replaced by content at runtime, and should be preserved and - placed in your translation where necessary for it to be meaningful after - substitution. You may need to refer to the source string location to - understand what kind of content will be substituted if it's not clear from the - sentence. Example (``%s`` will be substituted with a file name or path): - - :: - - # PO file: - "There is no '%s' file." - - # Weblate: - There is no '%s' file. - -- **C escape characters** such as ``\n`` (line break) or ``\t`` (tabulation). In - the Weblate editor, the ``\n`` characters are replaced by ``↵`` (return) and - ``\t`` by ``↹``. Tabs are not used much, but you should make sure to use line - breaks in the same way as the original English string (Weblate will issue a - warning if you don't). Line breaks might sometimes be used for vertical - spacing, or manual wrapping of long lines which would otherwise be too long - especially in the editor translation). Example: - - :: - - # PO file: - "Scene '%s' is currently being edited.\n" - "Changes will only take effect when reloaded." - - # Weblate: - Scene '%s' is currently being edited.↵ - Changes will only take effect when reloaded. - -.. note:: - Only logical order of the characters matters, in the right-to-left text, format - specifiers may be displayed as ``s%``. - -Online documentation (RST) -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The documentation translations originate from reStructuredText (RST) files, -which also use their own markup syntax to style text, create internal and -external links, etc. Here are some examples: - -:: - - # "development" is styled bold. - # "Have a look here" is a link pointing to https://docs.godotengine.org/en/latest. - # You should translate "Have a look here", but not the URL, unless there is - # a matching URL for the same content in your language. - # Note: The `, <, >, and _ characters all have a meaning in the hyperlink - # syntax and should be preserved. - - Looking for the documentation of the current **development** branch? - `Have a look here `_. - - # "|supported|" is an inline reference to an image and should stay unchanged. - # "master" uses the markup for inline code, and will be styled as such. - # Note: Inline code in RST uses 2 backticks on each side, unlike Markdown. - # Single backticks are used for hyperlinks. - - |supported| Backwards-compatible new features (backported from the ``master`` - branch) as well as bug, security, and platform support fixes. - - # The :ref: Sphinx "role" is used for internal references to other pages of - # the documentation. - # It can be used with only the reference name of a page (which should not be - # changed), in which case the title of that page will be displayed: - - See :ref:`doc_ways_to_contribute`. - - # Or it can be used with an optional custom title, which should thus be translated: - - See :ref:`how to contribute `. - - # You may encounter other Sphinx roles, such as :kbd: used for shortcut keys. - # You can translate the content between backticks to match the usual key names, - # if it's different from the English one. - - Save the scene. Click Scene -> Save, or press :kbd:`Ctrl + S` on Windows/Linux - or :kbd:`Cmd + S` on macOS. - -.. seealso:: - - See Sphinx's `reStructured Text primer `__ - for a quick overview of the markup language you may find in source strings. - You may encounter especially the inline markup (bold, italics, inline code) - and the internal and external hyperlink markup. - -Class reference (BBCode) -~~~~~~~~~~~~~~~~~~~~~~~~ - -The class reference is documented in the main Godot repository using XML files, -and with BBCode-like markup for styling and internal references. - -Some of the tags used are from the original BBCode (e.g. ``[b]Bold[/b]`` and -``[i]Italics[/i]``), while others are Godot-specific and used for advanced -features such as inline code (e.g. ``[code]true[/code]``), linking to another -class (e.g. ``[Node2D]``) or to a property in a given class (e.g. -``[member Node2D.position]``), or for multiline code blocks. Example: - -:: - - Returns a color according to the standardized [code]name[/code] with [code]alpha[/code] ranging from 0 to 1. - [codeblock] - red = ColorN("red", 1) - [/codeblock] - Supported color names are the same as the constants defined in [Color]. - -In the above example, ``[code]name[/code]``, ``[code]alpha[/code]``, and -``[Color]`` should *not* be translated, as they refer respectively to argument -names and a class of the Godot API. Similarly, the contents of the -``[codeblock]`` should not be translated, as ``ColorN`` is a function of the -Godot API and ``"red"`` is one of the named colors it supports. At most, you can -translate the name of the variable which holds the result (``red = ...``). - -Note also that in the XML, each line is a paragraph, so you should not add line -breaks if they are not part of the original translation. - -.. seealso:: - - See our documentation for class reference writers for the :ref:`list of - BBCode-like tags ` which are used - throughout the class reference. - -Offline translation and testing -------------------------------- - -While we advise using the Weblate interface to write translations, you also have -the possibility to download the PO file locally to translate it with your -preferred PO editing application, such as `Poedit `__ or -`Lokalize `__. - -To download the PO file locally, browse to the translation overview for your -language, and select the first item in the "Files" menu: - -.. image:: img/l10n_07_download_po_file.png - -Once you are done with a series of edits, use the "Upload translation" item in -that same menu and select your file. Choose "Add as translation" for the file -upload mode. - -.. note:: - - If a significant amount of time has passed between your download of the PO - file and the upload of the edited version, there is a risk to overwrite the - translations authored by other contributors in the meantime. This is why we - advise to use the online interface so that you always work on the latest - version. - -If you want to test changes locally (especially for the editor translation), you -can use the downloaded PO file and :ref:`compile Godot from source `. - -Rename the editor translation PO file to ``.po`` (e.g. ``eo.po`` for -Esperanto) and place it in the ``editor/translations/`` folder -(`GitHub `__). - -You can also test class reference changes the same way by renaming the PO file -similarly and placing it in the ``doc/translations/`` folder -(`GitHub `__). - -Localizing documentation images -------------------------------- - -The online documentation includes many images, which can be screenshots of the -Godot editor, custom-made graphs, of any other kind of visual content. Some of -it includes text and might thus be relevant to localize in your language. - -This part is not handled via Weblate, but directly on the `godot-docs-l10n -`_ Git repository where the -documentation translations are synced from Weblate. - -.. note:: - - The workflow is not the most straightforward and requires some knowledge of - Git. We plan to work on a simplified Web tool which could be used to manage - image localization in a convenient way, abstracting away these steps. - -To translate an image, you should first locate it in the original English -documentation. To do so, browse the relevant page in the docs, e.g. -:ref:`doc_intro_to_the_editor_interface`. Click the "Edit on GitHub" link in the -top right corner: - -.. image:: img/l10n_08_edit_on_github.png - -On GitHub, click on the image you want to translate. If relevant, click on -"Download" to download it locally and edit it with an image edition tool. -Note the full path to the image as it will be needed further down (here -``getting_started/step_by_step/img/project_manager_first_open.png``). - -.. image:: img/l10n_09_path_to_image.png - -Create your localized version of the image, either by editing the English one, -or by taking a screenshot of the editor with your language, if it's an editor -screenshot. Some images may also have source files available in SVG format, so -you can browse the ``img/`` folder which contains them to check for that. - -Name your localized image like the original one, but with the language code -added before the extension, e.g. ``project_manager_first_open.png`` would become -``project_manager_first_open.fr.png`` for the French localization. - -Finally, on godot-docs-l10n_, recreate the same folder structure as for the -original image in the ``images`` subfolder -(`GitHub `_), -and place your translated image there. In our example, the end result should be -``images/getting_started/step_by_step/img/project_manager_first_open.fr.png``. - -Repeat this for other images and :ref:`make a Pull Request `. diff --git a/contributing/documentation/img/crop_edit.webp b/contributing/documentation/img/crop_edit.webp deleted file mode 100644 index 26d625dbb..000000000 Binary files a/contributing/documentation/img/crop_edit.webp and /dev/null differ diff --git a/contributing/documentation/img/crop_pixels.webp b/contributing/documentation/img/crop_pixels.webp deleted file mode 100644 index 54be718f1..000000000 Binary files a/contributing/documentation/img/crop_pixels.webp and /dev/null differ diff --git a/contributing/documentation/img/crop_tool.webp b/contributing/documentation/img/crop_tool.webp deleted file mode 100644 index 904cf14d4..000000000 Binary files a/contributing/documentation/img/crop_tool.webp and /dev/null differ diff --git a/contributing/documentation/img/cropped_image.webp b/contributing/documentation/img/cropped_image.webp deleted file mode 100644 index af441e6f5..000000000 Binary files a/contributing/documentation/img/cropped_image.webp and /dev/null differ diff --git a/contributing/documentation/img/editor-vocabulary-overview.png b/contributing/documentation/img/editor-vocabulary-overview.png deleted file mode 100644 index 066f2562a..000000000 Binary files a/contributing/documentation/img/editor-vocabulary-overview.png and /dev/null differ diff --git a/contributing/documentation/img/l10n_01_language_list.png b/contributing/documentation/img/l10n_01_language_list.png deleted file mode 100644 index 8d1726f60..000000000 Binary files a/contributing/documentation/img/l10n_01_language_list.png and /dev/null differ diff --git a/contributing/documentation/img/l10n_02_new_translation.png b/contributing/documentation/img/l10n_02_new_translation.png deleted file mode 100644 index c953a3359..000000000 Binary files a/contributing/documentation/img/l10n_02_new_translation.png and /dev/null differ diff --git a/contributing/documentation/img/l10n_03_translation_overview.png b/contributing/documentation/img/l10n_03_translation_overview.png deleted file mode 100644 index 96642cc56..000000000 Binary files a/contributing/documentation/img/l10n_03_translation_overview.png and /dev/null differ diff --git a/contributing/documentation/img/l10n_04_translation_interface.png b/contributing/documentation/img/l10n_04_translation_interface.png deleted file mode 100644 index 7666b03f8..000000000 Binary files a/contributing/documentation/img/l10n_04_translation_interface.png and /dev/null differ diff --git a/contributing/documentation/img/l10n_05_search_location.png b/contributing/documentation/img/l10n_05_search_location.png deleted file mode 100644 index e4da602c4..000000000 Binary files a/contributing/documentation/img/l10n_05_search_location.png and /dev/null differ diff --git a/contributing/documentation/img/l10n_06_browse_by_location.png b/contributing/documentation/img/l10n_06_browse_by_location.png deleted file mode 100644 index ed3a392b2..000000000 Binary files a/contributing/documentation/img/l10n_06_browse_by_location.png and /dev/null differ diff --git a/contributing/documentation/img/l10n_07_download_po_file.png b/contributing/documentation/img/l10n_07_download_po_file.png deleted file mode 100644 index 5b71307b6..000000000 Binary files a/contributing/documentation/img/l10n_07_download_po_file.png and /dev/null differ diff --git a/contributing/documentation/img/l10n_08_edit_on_github.png b/contributing/documentation/img/l10n_08_edit_on_github.png deleted file mode 100644 index 7c4e7984b..000000000 Binary files a/contributing/documentation/img/l10n_08_edit_on_github.png and /dev/null differ diff --git a/contributing/documentation/img/l10n_09_path_to_image.png b/contributing/documentation/img/l10n_09_path_to_image.png deleted file mode 100644 index 55742205c..000000000 Binary files a/contributing/documentation/img/l10n_09_path_to_image.png and /dev/null differ diff --git a/contributing/documentation/index.rst b/contributing/documentation/index.rst deleted file mode 100644 index 54e23de38..000000000 --- a/contributing/documentation/index.rst +++ /dev/null @@ -1,71 +0,0 @@ -:allow_comments: False - -.. _doc_contributing_writing_documentation: - -Writing documentation -===================== - -We always need help to improve the documentation, be it the class reference or -the manual. Below, you can find our content and writing guidelines and -concrete guides to make changes to the documentation. - -Be sure to also check the :ref:`workflow guidelines `, -especially if you're new to using Git or GitHub. - -Guidelines ----------- - -Here are the principles and guidelines we strive to follow to write accessible -documentation. - -.. toctree:: - :maxdepth: 1 - :name: toc-contributing-writing-guidelines - - content_guidelines - docs_writing_guidelines - docs_image_guidelines - docs_contribution_checklist - -Writing the manual ------------------- - -These articles explain how to contribute to this very documentation, and -how to build the online version locally for testing. - -.. toctree:: - :maxdepth: 1 - :name: toc-contributing-documentation - - contributing_to_the_documentation - building_the_manual - -Class reference guides ----------------------- - -The pages below focus on the class reference. - -As the reference is included in the Godot editor, its source files are part of -the `godot repository `_. We use XML files -to write it, so the process to contribute to the class reference differs from -writing the online manual. - -.. toctree:: - :maxdepth: 1 - :name: toc-contributing-class-reference - - updating_the_class_reference - class_reference_primer - -Translating the documentation ------------------------------ - -The community is always working hard on making Godot and its documentation -available to more people. Localizing the documentation is a colossal and ongoing -effort you can be part of. - -.. toctree:: - :maxdepth: 1 - :name: toc-contributing-localization - - editor_and_docs_localization diff --git a/contributing/documentation/updating_the_class_reference.rst b/contributing/documentation/updating_the_class_reference.rst deleted file mode 100644 index f06d223e3..000000000 --- a/contributing/documentation/updating_the_class_reference.rst +++ /dev/null @@ -1,115 +0,0 @@ -.. _doc_updating_the_class_reference: - -Contributing to the class reference -=================================== - -.. highlight:: shell - -The :ref:`Class reference ` is a set of articles describing -the public API of the engine. This includes descriptions for various classes, -methods, properties, and global objects, available for scripting. The class reference -is available online, from the documentation sidebar, and in the Godot editor, from -the help menu. - -As the engine grows and features are added or modified, some parts of the class -reference become obsolete and new descriptions and examples need to be added. -While developers are required to document their work in the class reference when -submitting a pull request, we can't expect every programmer to be a good -technical writer. There is always work for contributors like you to polish -existing and create missing reference material. - -The source of the class reference ---------------------------------- - -As the class reference is available in two places, online and in the editor, we need to -take care to keep things in sync. To achieve this the `main Godot repository `_ -is picked as the source of truth, and the documentation for the class reference is tracked there. - -.. warning:: - - You should **not** edit ``.rst`` files in the ``classes/`` folder of the - `documentation repository `_. - These files are generated automatically and are synced manually by project - maintainers. Read further to learn how to correctly edit the class reference. - -In the main repository the class reference is stored in XML files, one for each exposed -class or global object. The majority of these files is located in `doc/classes/ -`_, but some modules -contain their own documentation as well. You will find it in the ``modules//doc_classes/`` -directory. To learn more about editing XML files refer to :ref:`doc_class_reference_primer`. - -.. seealso:: - - For details on Git usage and the pull request workflow, please - refer to the :ref:`doc_pr_workflow` page. - - If you want to translate the class reference from English to another - language, see :ref:`doc_editor_and_docs_localization`. This guide is - also available as a `video tutorial on YouTube - `_. - -**Important:** If you plan to make large changes, you should create an issue on -the `godot-docs repository `_ -or comment on an existing issue. Doing so lets others know you're already -taking care of a given class. - -What to contribute ------------------- - -The natural place to start contributing is the classes that you are most familiar with. -This ensures that the added description will be based on experience and the necessary -know-how, not just the name of a method or a property. We advise not to add low effort -descriptions, no matter how appealing it may look. Such descriptions obscure the need -for documentation and are hard to identify automatically. - -.. seealso:: - - Following this principle is important and allows us to create tools for contributors. - Such as the class reference's `completion status tracker `_. - You can use it to quickly find documentation pages missing descriptions. - -If you decide to document a class, but don't know what a particular method does, don't -worry. Leave it for now, and list the methods you skipped when you open a pull request -with your changes. Another writer will take care of it. - -You can still look at the method's implementation in Godot's source code on GitHub. -If you have doubts, feel free to ask on the `Godot Forum `_ -and `Godot Contributors Chat `_. - -.. warning:: - - Unless you make minor changes, like fixing a typo, we do not recommend using the - GitHub web editor to edit the class reference's XML files. It lacks features to edit - XML well, like keeping indentations consistent, and it does not allow amending commits - based on reviews. - - It also doesn't allow you to test your changes in the engine or with validation - scripts as described in :ref:`doc_class_reference_editing_xml`. - - -Updating class reference when working on the engine ---------------------------------------------------- - -When you create a new class or modify an existing engine's API, you need to re-generate -the XML files in ``doc/classes/``. - -To do so, you first need to compile Godot. See the :ref:`doc_introduction_to_the_buildsystem` -page to learn how. Then, execute the compiled Godot binary from the Godot root directory -with the ``--doctool`` option. For example, if you're on 64-bit Linux, the command might be: - -:: - - ./bin/godot.linuxbsd.editor.x86_64 --doctool - -The exact set of suffixes may be different. Carefully read through the linked article to -learn more about that. - -The XML files in ``doc/classes/`` should then be up-to-date with current Godot Engine -features. You can then check what changed using the ``git diff`` command. - -Please only include changes that are relevant to your work on the API in your commits. -You can discard changes in other XML files using ``git checkout``, but consider reporting -if you notice unrelated files being updated. Ideally, running this command should only -bring up the changes that you yourself have made. - -You will then need to add descriptions to any newly generated entries. diff --git a/contributing/how_to_contribute.rst b/contributing/how_to_contribute.rst deleted file mode 100644 index ecb2a2c13..000000000 --- a/contributing/how_to_contribute.rst +++ /dev/null @@ -1,110 +0,0 @@ -.. _doc_ways_to_contribute: - -How to contribute -================= - -The Godot Engine is free and open-source. Like any community-driven project, we rely on volunteer contributions. -On this page we want to showcase the various ways you as users can participate - to help you find the right starting place with the skillset you have. -Because contrary to popular opinion, we need more than just programmers on the project! - - -Fundraising ------------ - -- **Donate** - - We created the non-profit `Godot Foundation `_ to be able to support the Godot Engine in both matters of finance and administration. - In practice, this means the Foundation hires people to work part-time or full-time on the project. - These jobs include engine development as well as related tasks like code reviews, production management, community & marketing efforts, and more. - - With as little as 5 EUR per month, you can help us keep going strong. - Currently, we are intending to hire more core developers, as to cover more ground with full-time specialists that supplement and guide volunteer work. - - `Join the Development Fund `_ - -- **Donation Drives** - Think about your followers on social media, or other communities you are active in. - Use that reach to remind your social environment that even small contributions can make a difference, especially when done by a great number of people at the same time. - - Are you a content creator? Consider adding a link to the `Godot Development Fund `_ to your descriptions. - If you do live streams, perhaps think about organizing a stream with donation incentives. - -.. - **Buy Official Merch** - -- **Publish Godot Games.** - You heard right, simply publishing a game #MadeWithGodot can positively impact the well-being of this project. - Your personal success elevates the engine to a viable alternative for other developers, growing the community further. - Additionally, it opens the door for us to approach industry contacts about possible collaborations. - - -Technical contributions ------------------------ - -- **Report bugs & other issues** - As active users of the engine, you are better equipped to identify bugs and other issues than anyone else. - To let us know about your findings, fill out this `bug report form `_ on our GitHub. - Make sure to include as much information as possible to ensure these issues can easily be reproduced by others. - - If you are interested in helping keep our bug tracker organized, you can even join the `bugsquad `_! - -- **Test Development Versions** - While it is recommended to use the stable releases for your projects, you can help us test dev releases, betas, and release candidates - by opening a copy of your project in them and checking what problems this introduces or maybe even solves. - Make sure to have a backup ready, since this can produce irreversible changes. - - Find recent `development versions `_ directly on our download page, or linked in their own blog posts. - -- **Contribute Engine Code (mainly C++)** - The engine development is mainly coordinated on our `Contributor RocketChat `_, - so if you are serious about making PRs you should join us there! - - Read more about the **technical submission process**: :ref:`doc_first_steps` - - For each subject area of the engine, there is a corresponding team to coordinate the work. - Join the linked chat to get more eyes on your related PR, learn about open todos, or partake in meetings. - For some areas, specialists might even be encouraged to step up as maintainer! - `List of teams `_ - -- **Review Code Contributions** - All pull requests need to be thoroughly reviewed before they can be merged into the master branch. - Help us get a headstart by participating in the code review process. - - To get started, chose any `open pull request `_ and reference our **style guide**: :ref:`doc_pr_review_guidelines` - -- **Write Plugins (GDScript, C#, & more)** - Community addons are not directly included in the core engine download or repository, yet they provide essential quality of life upgrades for your fellow game developers. - Upload your plugins to the `Godot Asset Library `_ to make them available to others. - - .. - update to talk about Asset Store later -- **Demo projects (GDScript, C#, and making Assets)** - We provide new users with `demo projects `_ so they can quickly test new features or get familiar with the engine in the first place. - At industry events, we might even exhibit these demo projects to showcase what Godot can do! - Help improve existing projects or supply your own to be added to the pool, and join the `demo channel `_ in the Contributor RocketChat to talk about it. - -- **Documentation** - The documentation is one of the most essential parts of any tech project, yet the need to document new features and substantial changes often gets overlooked. - Join the `documentation team `_ to improve the Godot Engine with your technical writing skills. - -- **Translations (spoken languages other than English)** - Are you interested in making the Godot Engine more accessible to non-English speakers? - Contribute to our `community-translations `_. - -Community support ------------------ - -- **Call for Moderators** - With a community of our size, we need people to step up as volunteer moderators in all kinds of places. - These teams are organized by the Godot Foundation, but would not function without the dedication of active community members like you. - - Have a look around your favorite community platform and you might come across open application calls. - -- **Answer tech-support questions** - With many new people discovering the Godot Engine recently, the need for peer-to-peer tech-support has never been greater. - See the `Godot website `_ for a list of official and user-supported Godot communities. - -- **Create tutorials & more** - How did you get started with the Godot Engine? - Chances are you looked for learning materials outside of what the documentation provides. - Without content creators covering the game development process, there would not be this big of a community today. - Therefore it seemed only right to mention them in a page about important contributions to the project. diff --git a/contributing/workflow/bisecting_regressions.rst b/contributing/workflow/bisecting_regressions.rst deleted file mode 100644 index 6ce802a58..000000000 --- a/contributing/workflow/bisecting_regressions.rst +++ /dev/null @@ -1,163 +0,0 @@ -.. _doc_bisecting_regressions: - -Bisecting regressions -===================== - -.. highlight:: shell - -Bisecting is a way to find regressions in software. After reporting a bug on the -`Godot repository on GitHub `__, you may -be asked by a contributor to *bisect* the issue. Bisecting makes it possible for -contributors to fix bugs faster, as they can know in advance which commit caused -the regression. Your effort will be widely appreciated :) - -The guide below explains how to find a regression by bisecting. - -What is bisecting? ------------------- - -Godot developers use the `Git `__ version control system. -In the context of Git, bisecting is the process of performing a manual -`binary search `__ -to determine when a regression appeared. While it's typically used for bugs, -it can also be used to find other kinds of unexpected changes such as -performance regressions. - -Using official builds to speed up bisecting -------------------------------------------- - -Before using Git's ``bisect`` command, we strongly recommend trying to reproduce -the bug with an older (or newer) official release. This greatly reduces the -range of commits that potentially need to be built from source and tested. -You can find binaries of official releases, as well as alphas, betas, -and release candidates `here `__. - -.. danger:: - - Project files may be incompatible between Godot versions. - **Make a backup of your project** before starting the bisection process. - - Going from the oldest to the newest build generally reduces the risk of the - project not being able to successfully open in the editor, thanks to - backwards compatibility. Try to reduce your project to the smallest - repeatable example too. The more minimal the project is, the more likely - you'll be able to open it without compatibility issues in newer engine - versions. - -The Git bisect command ----------------------- - -If you've found a build that didn't exhibit the bug in the above testing -process, you can now start bisecting the regression. The Git version control -system offers a built-in command for this: ``git bisect``. This makes the -process semi-automated as you only have to build the engine, run it and try to -reproduce the bug. - -.. note:: - - Before bisecting a regression, you need to set up a build environment to - compile Godot from source. To do so, read the - :ref:`Compiling ` page for your target platform. - (Compiling Godot from source doesn't require C++ programming knowledge.) - - Note that compiling Godot can take a while on slow hardware (up an hour for - each full rebuild on a slow dual-core CPU). This means the full process can - take up to several hours. If your hardware is too slow, you may want to stop - there and report the results of your "pre-bisecting" on the GitHub issue so - another contributor can continue bisecting from there. - -Determine the commit hashes -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To start bisecting, you must first determine the commit hashes (identifiers) of -the "bad" and "good" build. "bad" refers to the build that exhibits the bug, -whereas "good" refers to the version that doesn't exhibit the bug. - -You can use either a commit hash (like ``06acfccf8``), the tag of a stable -release (like ``4.2.1-stable``), or a branch like ``master``. - -If you're using a pre-release build as the "good" or "bad" build, you can find -the commit hash in the Project Manager in the lower-right corner, or in in the -**Help > About Godot** dialog in the Godot editor. The version information will -look something like ``v4.4.beta3.official [06acfccf8]``, and the commit hash is -within the brackets, in this case ``06acfccf8``. You can click on the version -information to copy it, including the commit hash. - -Alternately, you can browse the `interactive changelog -`__ to find commits -for all releases, including development builds. The commits will be listed as a -range, like ``commits: a013481b0...06acfccf8``, and the second commit is the one -you should use for bisecting. You can also browse the `Godot Archive -`__, and find the commit hash within -the release page linked from the **News** button. - -If you're using a stable release as the "good" or "bad" build, you can use the -tag of that release directly, such as ``4.2-stable`` or ``4.2.1-stable``. A full -list of release tags is available `on GitHub -`__, and you can also find the actual -commit hash that corresponds to a stable release there. - -To refer to the latest state of the master branch, you can use ``master`` -instead of a commit hash. Note that unlike tagged releases or snapshot commit -hashes, ``master`` is a perpetually moving target. - -Build the engine -~~~~~~~~~~~~~~~~ - -:ref:`Get Godot's source code using Git `. Once this -is done, in the terminal window, use ``cd`` to reach the Godot repository -folder and enter the following command: - -.. code-block:: shell - - # is hash of the build that works as expected. - # is hash of the build exhibiting the bug. - git bisect start - git bisect good - git bisect bad - -Compile Godot. This assumes you've set up a build environment: - -.. code-block:: shell - - scons - -Run the engine -~~~~~~~~~~~~~~ - -Run the binary located in the ``bin/`` folder and try to reproduce the bug. - -.. note:: - - :ref:`Double-check the output file name ` - in ``bin/`` to make sure you're actually running the binary you've just compiled. - Different Godot versions will output binaries with different names. - -If the build **still** exhibits the bug, run the following command: - -.. code-block:: shell - - git bisect bad - -If the build **does not** exhibit the bug, run the following command: - -.. code-block:: shell - - git bisect good - -After entering one of the commands above, Git will switch to a different commit. -You should now build Godot again, try to reproduce the bug, then enter ``git -bisect good`` or ``git bisect bad`` depending on the result. You'll have to -repeat this several times. The longer the commit range, the more steps will be -required. 5 to 10 steps are usually sufficient to find most regressions; Git -will remind you of the number of steps remaining (in the worst case scenario). - -Once you've completed enough steps, Git will display the commit hash where the -regression appeared. Write this commit hash as a comment to the GitHub issue -you've bisected. This will help in solving the issue. Thanks again for -contributing to Godot :) - -.. seealso:: - - You can read the full documentation on ``git bisect`` - `here `__. diff --git a/contributing/workflow/bug_triage_guidelines.rst b/contributing/workflow/bug_triage_guidelines.rst deleted file mode 100644 index cb868562a..000000000 --- a/contributing/workflow/bug_triage_guidelines.rst +++ /dev/null @@ -1,287 +0,0 @@ -.. _doc_bug_triage_guidelines: - -Bug triage guidelines -===================== - -This page describes the typical workflow of the bug triage team aka -bugsquad when handling issues and pull requests on Godot's -`GitHub repository `__. -It is bound to evolve together with the bugsquad, so do not -hesitate to propose modifications to the following guidelines. - -Issues management ------------------ - -For issue management, we use the following GitHub processes: - -- Each issue and pull request (PR) is categorized with a set of *labels*, - sometimes called "tags". -- Each PR is assigned to a *milestone*. Some issues can also be assigned to a - *milestone* (see below). -- Issues can have an *assignee*, who is a contributor among Godot maintainers. -- Issues can be put in one or more *projects*. -- PRs can be *linked* to one or more issues which they "fix" or "close". - -We don't yet extensively use or rely on some other GitHub processes: - -- Issue close reasons (completed, not planned, duplicate). While we use these, - it is not consistent, and older issues are all closed as "completed", so the - issue close reason should not be relied on. -- Issue *types* (Bug, Feature, Task). -- Issue *relationships*. - -We only use the assignees feature for Godot maintainers who are members of the -Godot Engine GitHub organization, and even then not in all cases. For other -issues, we track who is working on an issue by comments on the issue and linked -pull requests. Most issues are available for any contributor to take on, after -discussing it with other contributors. If you would like to work on an issue, -first check that no one else is working on it, by looking for a linked pull -request, a comment "claiming" the issue, or an assignee. If no one else is -working on the issue, leave a comment on the issue to "claim" it and start -working on it. - -Labels -~~~~~~ - -The following `labels `__ are -currently defined in the Godot repository: - -Categories: -^^^^^^^^^^^ - -- *Archived*: used to filter issues closed with a resolution other than "fixed". - - - For issues, added to all issues that are not resolved by engine or - documentation changes. This includes duplicate issues, user error, or - reports in the wrong repository. - Since we don't rely on GitHub's issue close reasons (``completed``, ``not - planned``, and ``duplicate``), it is possible for an issue to be closed as - ``completed`` with the *Archived* label. - - For PRs, added to all closed PRs that are not merged. This includes superseded - or duplicate PRs, Git or GitHub mistakes, and valid PRs that end up not merged. - -- *Breaks compat*: describes something that can only be fixed by breaking - compatibility with existing projects. -- *Bug*: describes something that is not working properly. -- *Cherrypick*: describes something that can be backported to a stable branch - after being merged in the ``master`` branch. -- *Confirmed*: has been confirmed by at least one other contributor - than the bug reporter (typically for *Bug* reports). - The purpose of this label is to let developers know which issues are - still reproducible when they want to select what to work on. It is - therefore a good practice to add in a comment on what platform and - what version or commit of Godot the issue could be reproduced; if a - developer looks at the issue one year later, the *Confirmed* label - may not be relevant anymore. -- *Crash:* describes a bug that causes the engine to crash. - This label is only used for "hard" crashes, not freezes. -- *Discussion*: the issue is not consensual and needs further - discussion to define what exactly should be done to address the - topic. -- *Documentation*: related to the documentation. PRs with this label improve the - class reference. Issues with this label are either for wrong documentation, or - are user-reported "bugs" that are actually limitations to be further documented. - Often paired with *Discussion*. Issues related to the ReadTheDocs documentation - should be filed on the `godot-docs `_ repository. -- *Enhancement*: describes a proposed enhancement to an existing - functionality. -- *Feature proposal*: used for PRs adding new features which do not have a - corresponding proposal use this label. The label is removed when a feature - proposal is created and linked. The main Godot repository no longer accepts - feature requests as issues. Please use the `godot-proposals - `__ repository instead. -- *For PR meeting*: the issue needs to be discussed in a pull request meeting. - These meetings are public and are held on the `Godot Contributors Chat `_. -- *Good first issue*: the issue is *assumed* to be an easy one to fix, which makes - it a great fit for new contributors who want to become familiar with - the code base. It should be removed while an active PR is available, that - resolves this issue. -- *High priority:* the issue is particularly important as it can - prevent people from releasing their projects or cause data loss. -- *Needs testing*: the issue/pull request could not be completely tested - and thus need further testing. This can mean that it needs to be tested - on different hardware/software configurations or even that the steps to - reproduce are not certain. -- *Needs work*: the pull request needs additional work before it can be merged. - Also for issues that are very incomplete, such as missing reproduction steps. -- *Performance*: issues that directly impact engine or editor performance. - Can also be used for pull requests that improve performance or add low-end-friendly options. - Should not be coupled with *Usability*. -- *Regression*: the bug appeared after a stable release not exhibiting - the bug was released. -- *Salvageable*: the pull request can't be merged due to design issues or - merge conflicts and its author is not active anymore. However, it can still - be picked up by another contributor to bring it to a mergeable state. - To do so, you need to open a new pull request based on the original pull request. -- *Spam*: intentional spam issues, and extremely low-effort PRs. Used - sparingly, since we give contributors and users the benefit of the doubt. In - most cases, *Needs work* or *Archived* is more appropriate. -- *Tracker*: issue used to track other issues (like all issues related to - the plugin system). -- *Usability*: issues that directly impact user usability. Should not be coupled with *Performance*. - -The categories are used for general triage of the issues. They can be combined -in some way when relevant, e.g. an issue can be labeled *Bug* and *Usability* -at the same time if it's a bug that affects usability. Or *Enhancement* and -*Discussion* if it's an improvement that requires discussion of the best -approach. At least one of the categories *Bug*, *Enhancement*, or *Discussion* -are used to describe an issue or pull request. - -Topics: -^^^^^^^ - -- *2D*: relates to 2D nodes. Should be coupled with one of the labels - below, and should not be coupled with *3D*. -- *3D*: relates to 3D nodes. Should be coupled with one of the labels - below, and should not be coupled with *2D*. -- *Animation*: relates to the Animation system, editors and importers. -- *Assetlib*: relates to issues with the asset library. -- *Audio*: relates to the audio features (low- and high-level). -- *Buildsystem*: relates to building issues, either linked to the SCons - buildsystem or to compiler peculiarities. -- *Codestyle*: relates to the programming style used within the codebase. -- *Core*: anything related to the core engine. Specific topics are split off separately as they crop up. -- *Dotnet*: relates to the C# / .NET bindings. -- *Editor*: relates to issues in the editor (mainly UI). -- *Export*: relates to the export system and templates. -- *GDExtension*: relates to the GDExtension system for native extensions. -- *GDScript*: relates to GDScript. -- *GUI*: relates to GUI (Control) nodes or to Nodes that compose user interfaces. -- *Import*: relates to the resource import system. -- *Input*: relates to the input system. -- *I18n*: relates to internationalization. -- *Multiplayer*: relates to multiplayer (high-level networking) systems. -- *Navigation*: relates to the navigation system (including A* and navmeshes). -- *Network*: relates to (low-level) networking. -- *Particles*: particles, particle systems and their editors. -- *Physics*: relates to the physics engine (2D/3D). -- *Plugin*: relates to problems encountered while writing plugins. -- *Porting*: relates to some specific platforms or exporting projects. -- *Rendering*: relates to the 2D and 3D rendering engines. -- *Shaders*: relates to the Godot shader language or visual shaders. -- *Tests*: relates to unit tests. -- *Thirdparty*: relates to third-party libraries used in Godot. -- *XR*: relates to Augmented Reality or Virtual Reality. - -Issues would typically correspond to only one topic, though it's not -unthinkable to see issues that fit two bills. The general idea is that -there will be specialized contributors teams behind all topics, so they -can focus on the issues labelled with their team's topic. - -Platforms: -^^^^^^^^^^ - -*Android*, *iOS*, *LinuxBSD*, *macOS*, *Web*, *Windows* - -By default, it is assumed that a given issue applies to all platforms. -If one of the platform labels is used, it is then exclusive and the -previous assumption doesn't stand anymore (so if it's a bug on e.g. -Android and Linux exclusively, select those two platforms). - -Documentation labels -~~~~~~~~~~~~~~~~~~~~ - -In the `documentation repository `__, we -use the following `labels `__: - -- *Archived*: either a duplicate of another issue, or invalid. Such an - issue would also be closed. -- *Bug*: Incorrect information in an existing page. Not to be used for - *missing* information. -- *Cherrypick*: describes something that can be backported to a stable branch - after being merged in the ``master`` branch. -- *Dependencies*: describes pull requests that update a dependency file. -- *Discussion*: the issue is not consensual and needs further - discussion to define what exactly should be done to address the - topic. -- *Enhancement*: new information to be added in an existing page. -- *Good first issue*: the issue is *assumed* to be an easy one to fix, which makes - it a great fit for new contributors who want to become familiar with - the code base. It should be removed while an active PR is available, that - resolves this issue. -- *Linked demo PR*: the PR has a corresponding PR to the - `Godot Demo Projects `__ - repository which must be merged at the same time. Any changes to code in - tutorials that have a corresponding demo, such as :ref:`doc_your_first_2d_game`, - need to update both repositories so that the tutorial code stays in sync with - the completed demo. -- *Needs work*: the pull request needs additional work before it can be merged. -- *Python*: Pull requests that update Python code. -- *Salvageable*: the pull request can't be merged due to design issues or - merge conflicts and its author is not active anymore. However, it can still - be picked up by an external contributor to bring it to a mergeable state. - To do so, you need to open a new pull request based on the original pull request. -- *Tracker*: issue used to track other issues (like all issues related to - the plugin system). -- *Waiting on PR merge*: the PR documents an engine PR that has not been merged - yet. - -Area: -^^^^^ - -- *About*: Issues and PRs related to the About section of the documentation and other general articles. -- *Class reference*: the issue is about the class reference, not a documentation page. -- *Community*: Issues and PRs related to the Community section of the documentation. -- *Contributing*: Issues and PRs related to the Contributing/Development section of the documentation. -- *Getting started*: Issues and PRs related to the Getting Started section of the documentation. -- *Manual*: Issues and PRs related to the Manual/Tutorials section of the documentation. - -Content: -^^^^^^^^ - -- *Images*: Issues and PRs involving outdated or incorrect images in articles. -- *Example code*: Issues and PRs involving writing or updating code examples. -- *New page*: Issues and PRs related to creation of new documentation pages for new or undocumented features. -- *Organization*: Issues and PRs related to reorganizing the content. -- *Proofreading*: Issues and PRs related to proofreading the documentation. -- *Redirect*: Issues and PRs involving moving content and adding a redirect rule on the backend. -- *Website*: Issues related to adding website features and fixing bugs, whether on the front or back-end, - -Topic: -^^^^^^ - -The available topics describe the same content as the topics in the main -repository. - -Milestones -~~~~~~~~~~ - -`Milestones `_ are used for -some issues and all PRs. - -We have milestones for specific minor engine versions, like ``4.5`` and ``4.6``, -as well as general milestones for major engine versions, like ``3.x`` and -``4.x``. In the ``godot-proposals`` repo, we also have a ``5.0`` milestone for -compatibility-breaking changes that will be considered for Godot 5.0, in many -years. - -Issues are assigned to the current development milestone, such as ``4.5``, if -they are related to features introduced in that engine version, or are bugs -(regressions) in that version. Additionally, all issues completed during the -development of that engine version are added to the milestone, so that users can -see at a glance in which minor version an issue was first fixed. We don't always -use the ``4.x`` milestone for issues, since by default all issues are related to -Godot 4.x. However, we do use the ``3.x`` milestone to mark issues that are -specific to Godot 3.x. - -All pull requests are assigned to a milestone. By default, enhancement and -feature PRs are assigned to the ``4.x`` milestone, and bugs are assigned to the -current development milestone, such as ``4.5``. Towards the end of the minor -version's development, PRs currently in that milestone are reassessed. If -a PR is no longer being considered for that version, it is reassigned to either the -major version milestone (``4.x``), or the next minor version milestone (such as -``4.6``). - -Pull requests in the ``4.x`` milestone are reassigned to the current minor -engine version, such as ``4.5``, when the review process is complete, and the -production team decides that the PR is ready to be merged soon. Note that -this usually requires more than one approving review. - -The milestone assigned to a PR is a goal, not a guarantee. New features and -enhancements are merged when they are ready. While reviewers and maintainers do -their best to review PRs in time for the current version, at some point we reach -the beta, feature freeze, and then release; and existing PRs are reassigned to -the next minor version, or to ``4.x``. As a rule, we assign new features to the -``4.x`` milestone initially to avoid continually reassigning a PR from version -to version. However, a PR being in ``4.x`` does not mean it won't be merged; -it's just the default for new features. \ No newline at end of file diff --git a/contributing/workflow/first_steps.rst b/contributing/workflow/first_steps.rst deleted file mode 100644 index ef9c77d54..000000000 --- a/contributing/workflow/first_steps.rst +++ /dev/null @@ -1,128 +0,0 @@ -.. _doc_first_steps: - -Contributing code ------------------ - -The possibility to study, use, modify and redistribute modifications of the -engine's source code are the fundamental rights that -Godot's `MIT `_ license grants you, -making it `free and open source software `_. - -As such, everyone is entitled to modify -`Godot's source code `_, and send those -modifications back to the upstream project in the form of a patch (a text file -describing the changes in a ready-to-apply manner) or - in the modern workflow -that we use - via a so-called "pull request" (PR), i.e. a proposal to directly -merge one or more Git commits (patches) into the main development branch. - -Contributing code changes upstream has two big advantages: - -- Your own code will be reviewed and improved by other developers, and will be - further maintained directly in the upstream project, so you won't have to - reapply your own changes every time you move to a newer version. On the - other hand it comes with a responsibility, as your changes have to be - generic enough to be beneficial to all users, and not just your project; so - in some cases it might still be relevant to keep your changes only for your - own project, if they are too specific. - -- The whole community will benefit from your work, and other contributors will - behave the same way, contributing code that will be beneficial to you. At - the time of this writing, over 2,000 developers have contributed code - changes to the engine! - -To ensure good collaboration and overall quality, the Godot developers -enforce some rules for code contributions, for example regarding the style to -use in the C++ code (indentation, brackets, etc.) or the Git and PR workflow. - -A good place to start is by searching for issues tagged as -`good first issue `_ -on GitHub. - -.. seealso:: Technical details about the PR workflow are outlined in a - specific section, :ref:`doc_pr_workflow`. - - Details about the code style guidelines and the ``clang-format`` - tool used to enforce them are outlined in - :ref:`doc_code_style_guidelines`. - -All pull requests must go through a review process before being accepted. -Depending on the scope of the changes, it may take some time for a maintainer -responsible for the modified part of the engine to provide their review. -We value all of our contributors and ask them to be patient in the meantime, -as it is expected that in an open source project like Godot, there is going to be -way more contributions than people validating them. - -To make sure that your time and efforts aren't wasted, it is recommended to vet the idea -first before implementing it and putting it for a review as a PR. To that end, Godot -has a `proposal system `_. Its -usage is encouraged to plan changes and discuss them with the community. Implementation -details can also be discussed with other contributors on the `Godot Contributors Chat `_. - -.. note:: Proposals are only required when working on an enhancement or a new feature. - Bug reports are sufficient for fixing issues. - -Testing and reporting issues ----------------------------- - -Another great way of contributing to the engine is to test development releases -or the development branch and to report issues. It is also helpful to report -issues discovered in stable releases, so that they can be fixed in -the development branch and in future maintenance releases. - -Testing development versions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To help with the testing, you have several possibilities: - -- Compile the engine from source yourself, following the instructions of the - :ref:`Compiling ` page for your platform. - -- Test official pre-release binaries when they are announced (usually on the - blog and other community platforms), such as alpha, beta and release candidate (RC) builds. - -- Test "trusted" unofficial builds of the development branch; just ask - community members for reliable providers. Whenever possible, it's best to - use official binaries or to compile yourself though, to be sure about the - provenance of your binaries. - -As mentioned previously, it is also helpful to keep your eyes peeled for -potential bugs that might still be present in the stable releases, especially -when using some niche features of the engine which might get less testing by -the developers. - -Filing an issue on GitHub -~~~~~~~~~~~~~~~~~~~~~~~~~ - -Godot uses `GitHub's issue tracker `_ -for bug reports. When you start filing a bug report, you’ll be given a form to -fill out. Please try to follow it so that all issues are consistent and provide -the required information. - -Contributing to the documentation ---------------------------------- - -There are two separate resources referred to as "documentation" in Godot: - -- **The class reference.** This is the documentation for the complete Godot API - as exposed to GDScript and the other scripting languages. It can be consulted - offline, directly in Godot's code editor, or online at Godot :ref:`Class Reference - `. To contribute to the class reference, you have to edit the - XML file corresponding to the class and make a pull request. - See :ref:`doc_updating_the_class_reference` and :ref:`doc_class_reference_primer` - for more details. - -- **The tutorials and engine documentation and its translations.** - This is the part you are reading now, which is distributed in the HTML format. - Its contents are generated from plain text files in the reStructured Text - (rst) format, to which you can contribute via pull requests on the - `godot-docs `_ GitHub repository. - See :ref:`doc_contributing_to_the_documentation` for more details. - -Contributing translations -------------------------- - -To make Godot accessible to everyone, including users who may prefer resources -in their native language instead of English, our community helps translate both -the Godot editor and its documentation in many languages. - -See :ref:`doc_editor_and_docs_localization` for more details. diff --git a/contributing/workflow/img/github_fork_button.png b/contributing/workflow/img/github_fork_button.png deleted file mode 100644 index aa4436e3e..000000000 Binary files a/contributing/workflow/img/github_fork_button.png and /dev/null differ diff --git a/contributing/workflow/img/github_fork_make_pr.png b/contributing/workflow/img/github_fork_make_pr.png deleted file mode 100644 index c7a815f8b..000000000 Binary files a/contributing/workflow/img/github_fork_make_pr.png and /dev/null differ diff --git a/contributing/workflow/img/github_fork_url.png b/contributing/workflow/img/github_fork_url.png deleted file mode 100644 index eb359aea1..000000000 Binary files a/contributing/workflow/img/github_fork_url.png and /dev/null differ diff --git a/contributing/workflow/img/testing_pull_requests_access_checks.webp b/contributing/workflow/img/testing_pull_requests_access_checks.webp deleted file mode 100644 index 4f5568729..000000000 Binary files a/contributing/workflow/img/testing_pull_requests_access_checks.webp and /dev/null differ diff --git a/contributing/workflow/img/testing_pull_requests_access_fork.png b/contributing/workflow/img/testing_pull_requests_access_fork.png deleted file mode 100644 index b53c8a723..000000000 Binary files a/contributing/workflow/img/testing_pull_requests_access_fork.png and /dev/null differ diff --git a/contributing/workflow/img/testing_pull_requests_checks_artifacts.webp b/contributing/workflow/img/testing_pull_requests_checks_artifacts.webp deleted file mode 100644 index d758290d9..000000000 Binary files a/contributing/workflow/img/testing_pull_requests_checks_artifacts.webp and /dev/null differ diff --git a/contributing/workflow/img/testing_pull_requests_checks_artifacts_list.webp b/contributing/workflow/img/testing_pull_requests_checks_artifacts_list.webp deleted file mode 100644 index c336fb5ae..000000000 Binary files a/contributing/workflow/img/testing_pull_requests_checks_artifacts_list.webp and /dev/null differ diff --git a/contributing/workflow/img/testing_pull_requests_command_line_checkout.webp b/contributing/workflow/img/testing_pull_requests_command_line_checkout.webp deleted file mode 100644 index 807b292d3..000000000 Binary files a/contributing/workflow/img/testing_pull_requests_command_line_checkout.webp and /dev/null differ diff --git a/contributing/workflow/img/testing_pull_requests_fork_zip.png b/contributing/workflow/img/testing_pull_requests_fork_zip.png deleted file mode 100644 index 07ee9f5f4..000000000 Binary files a/contributing/workflow/img/testing_pull_requests_fork_zip.png and /dev/null differ diff --git a/contributing/workflow/img/testing_pull_requests_nightly_link.png b/contributing/workflow/img/testing_pull_requests_nightly_link.png deleted file mode 100644 index e68e5ef9c..000000000 Binary files a/contributing/workflow/img/testing_pull_requests_nightly_link.png and /dev/null differ diff --git a/contributing/workflow/index.rst b/contributing/workflow/index.rst deleted file mode 100644 index 039f9adb0..000000000 --- a/contributing/workflow/index.rst +++ /dev/null @@ -1,22 +0,0 @@ -:allow_comments: False - -.. _doc_contributing_workflow: - -Contribution workflow -===================== - -Godot is a large project, both in terms of the codebase and the workload for -contributors. The guides below serve as a helper when you get stuck dealing -with Git or GitHub, or if you are generally interested in how maintainers -approach the project. - -.. toctree:: - :maxdepth: 1 - :name: toc-contributing-workflow - - first_steps - bisecting_regressions - bug_triage_guidelines - pr_workflow - pr_review_guidelines - testing_pull_requests diff --git a/contributing/workflow/pr_review_guidelines.rst b/contributing/workflow/pr_review_guidelines.rst deleted file mode 100644 index 9bdf71465..000000000 --- a/contributing/workflow/pr_review_guidelines.rst +++ /dev/null @@ -1,421 +0,0 @@ -.. _doc_pr_review_guidelines: - -Pull request review process -=========================== - -.. note:: - - This page is intended to provide insight into the pull request (PR) review - process that we aspire to. As such, it is primarily targeted at engine - maintainers who are responsible for reviewing and approving pull requests. - That being said, much of the content is useful for prospective contributors - wanting to know how to ensure that their PR is merged. - -From a high level, the ideal life cycle of a pull request looks like the -following: - - 1. A contributor opens a PR that fixes a specific problem (optimally closing - a GitHub `issue `_ or implementing - a `proposal `_). - - 2. Other contributors provide feedback on the PR (including reviewing and/or - approving the PR, as appropriate). - - 3. An engine maintainer reviews the code and provides feedback, requests - changes, or approves the pull request, as appropriate. - - 4. Another maintainer reviews the code with a focus on code style/clarity and - approves it once satisfied. - - 5. A team leader or a member of the `production team - `_ merges the pull request if - satisfied that it has been sufficiently reviewed. - -This document will explain steps 2, 3, 4, and 5 in more detail. For a more -detailed explanation of the pull request workflow please see the :ref:`pull -request workflow document `. - -.. note:: - In practice these steps may blend together. Oftentimes maintainers will - provide comments on code style and code quality at the same time and will - approve a pull request for both. - -Typically the first interaction on a pull request will be an engine maintainer -assigning tags to the pull request and flagging it for review by someone -familiar with that area of code. - -Engine maintainers are folks who are "members" of the Godot project repository -on GitHub and/or are listed on the `Teams page `_ -on the Godot website. Maintainers are responsible for a given area of the -engine. Typically this means they are the people who are given more trust to -approve and recommend pull requests for merging. - -Even if you are not a maintainer, you can still help by reviewing code, -providing feedback on PRs and testing PRs locally on your machine to confirm -that they work as intended. Many of the currently active maintainers started out -doing this before they became maintainers. - -Code review and testing ------------------------ - -The following is a list of things that contributors and engine maintainers can -do to conduct a substantive code review of a pull request. - -.. note:: - If you want to conduct a code review, but can't do everything on this list, - say that in your review comment. For example, it is still very helpful to - provide comments on code, even if you can't build the pull request locally to - test the pull request (or vice versa). Feel free to review the code, just - remember to make a note at the end of your review that you have reviewed the - code only and have not tested the changes locally. - -1. Confirm that the problem exists -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -PRs need to solve problems and problems need to be documented. Make sure that -the pull request links and closes (or at least addresses) a bug or a proposal. -If it doesn't, consider asking the contributor to update the opening message of -the PR to explain the problem that the PR aims to solve in more detail. - -.. note:: - It should be clear _why_ a pull request is needed before it is merged. This - assists reviewers in determining whether a PR does what it says it does and it - helps contributors in the future understand why the code is the way it is. - -2. Test the PR and look for regressions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -While strict code review and CI help to ensure that all pull requests work as -intended, mistakes happen and sometimes contributors push code that creates a -problem in addition to solving a problem. Maintainers will avoid merging code -that contains a regression even if it solves the problem as intended. - -When reviewing a pull request, ensure that the PR does what it says it does -(i.e. fixes the linked bug or implements the new feature) and nothing outside of -the PR target area is broken by the change. You can do this by running the -editor and trying out some common functions of the editor (adding objects to a -scene, running GDScript, opening and closing menus etc.). Also, while reviewing -the code, look for suspicious changes in other parts of the engine. Sometimes -during rebasing changes slip through that contributors are not aware of. - -3. Do a code review -~~~~~~~~~~~~~~~~~~~ - -Code reviews are usually done by people who are already experienced in a given -area. They may be able to provide ideas to make code faster, more organized, or -more idiomatic. But, even if you are not very experienced, you may want to -conduct a code review to provide feedback within the scope of what you are -comfortable reviewing. Doing so is valuable for the area maintainer (as a second -set of eyes on a problem is always helpful) and it is also helpful for you as it -will help you get more familiar with that area of code and will expose you to -how other people solve problems. In fact, reviewing the code of experienced -engine maintainers is a great way to get to know the codebase. - -Here are some things to think about and look out for as you review the code: - -* **Code only touches the areas announced in the PR (and the commit - message).** - - It can be tempting to fix random things in the code, as you see them. However, - this can quickly make a pull request difficult to review and can make it hard - to dig through in the commit history. Small touch-ups next to the related area - are alright, but often bugs that you can find along the way are better fixed - in their own PRs. - -* **Code properly uses Godot's own APIs and patterns.** - - Consistency is very important, and a solution that already exists in the - codebase is preferable to an ad-hoc solution. - -* **Are core areas affected by the change?** - - Sometimes a PR that is supposed to solve a local problem can have a - far-reaching effect way outside of its scope. Usually it is best to keep code - changes local to where the problem arises. If you think that the solution - requires changes outside the scope of the problem, it is usually best to seek - the opinion of a team leader who may have another idea for how to solve the - problem. - -4. Iterate with the contributor and improve the PR -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Maintainers should provide feedback and suggestions for improvement if they spot -things in the code that they would like changed. Preferably, suggestions should -come in order of importance: first, address overall code design and the approach -to solving the problem, then make sure the code is complying with the engine's -best practices, and lastly, do the :ref:`code style review `. - -.. note:: - - **Communicate barriers to merging early in the review process.** - - If the PR has clear blockers or will likely not get merged for whatever other - reason, that fact should be communicated as early and clearly as possible. We - want to avoid stringing people along because it feels bad to say "sorry, no". - -As you review pull requests, keep the Godot `Code of Conduct -`_ in mind. Especially the following: - -* Politeness is expected at all times. Be kind and courteous. - -* Always assume positive intent from others. - -* Feedback is always welcome, but keep your criticism constructive. - -Here are some things to avoid as you iterate on a pull request with a -contributor: - -* **Needless double reviews.** - - In other words, review the full PR at once and avoid coming back endless times - to point out issues that you could have noted in the first review. Of course, - this can't always be avoided, but we should try to catch everything at once. - -* **Being overly nitpicky.** - - Code quality can be flexible depending on the area of the engine you are - working in. In general, our standard for code quality is much higher in core - areas and in performance-sensitive areas than it is in editor code for - example. - -* **Expanding the scope of a pull request.** - - Providing context or related/similar issues or proposals that may be fixed - similarly can be helpful, but adding a "may as well fix that thing over there - as well while at it" or "could we add to this as well?" isn't always fair to - the contributor. Use your judgement when deciding whether additional fixes are - within scope, but try to keep the scope as close to the original pull request - as possible. - -And ultimately, don't feel pressured to deal with the PR all alone. Feel free to -ask for a helping hand on the `Godot Contributors Chat -`_, in the appropriate channel or in #general. -Other teams may already be tagged for review, so you can also wait or ask for -their assistance. - -5. Approve the pull request -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -After reviewing the code, if you think that the code is ready to be merged into -the engine, then go ahead and "approve" it. Make sure to also comment and -specify the nature of your review (i.e. say whether you ran the code locally, -whether you reviewed for style as well as correctness, etc.). Even if you are -not an engine maintainer, approving a pull request signals to others that the -code is good and likely solves the problem the PR says it does. Approving a pull -request as a non-engine maintainer does not guarantee that the code will be -merged, other people will still review it, so don't be shy. - -.. _doc_code_style_review: - -Code style review ------------------ - -Generally speaking, we aim to conduct a code review before a style/clarity -review as contributors typically want to know if their general approach is -acceptable before putting in the effort to make nitpicky changes to style. In -other words, maintainers shouldn't ask contributors to change the style of code -that may need to be rewritten in subsequent reviews. Similarly, maintainers -should avoid asking for contributors to rebase PRs if the PR has not been -reviewed. - -That being said, not everyone feels confident enough to provide a review on code -correctness, in that case, providing comments on code style and clarity ahead of -a more substantive code review is totally appropriate and more than welcome. - -In practice the code style review can be done as part of the substantive code -review. The important thing is that both the substantive code and the code style -need to be reviewed and considered before a pull request is merged. - -When reviewing code style pay particular attention to ensuring that the pull -request follows the :ref:`doc_code_style_guidelines`. While ``clang-format`` and -various CI checks can catch a lot of inconsistencies, they are far from perfect -and are unable to detect some issues. For example, you should check that: - - * The style of header includes is respected. - * Identifiers use ``snake_case`` and follow our naming conventions. - * Method parameters start with ``p_*`` or ``r_*`` (if they are used to return - a value). - * Braces are used appropriately, even for one-liner conditionals. - * Code is properly spaced (exactly one empty line between methods, no - unnecessary empty lines inside of method bodies). - -.. note:: - - This list is not complete and doesn't aim to be complete. Refer to - the linked style guide document for a complete set of rules. Keep - in mind that ``clang-format`` may not catch things you hope it would, - so pay attention and try to build a sense of what exactly it can and - cannot detect. - -Merging pull requests ---------------------- - -In general, pull requests should only be merged by members of the production -team or team leaders for pull requests in their area of the engine. For example, -the networking team leader could merge a networking pull request that doesn't -substantially change non-networking sections of code. - -In practice it is best to wait for a member of the production team to merge the -pull request as they keep a close eye on the entire codebase and will likely -have a better sense of what other recent/upcoming changes this pull request may -conflict with (or any other reason that it may make sense to delay the pull -request). Feel free to leave a comment saying that the PR should be ready to -merge. - -The following are the steps to take before merging a pull request. The degree to -which you adhere to these steps can be flexible for simple/straightforward pull -requests, but they should be carefully taken for complex or risky pull requests. - -As a contributor you can help move a pull request forward by doing some of these -steps yourself. - -1. Get feedback from the right people/teams -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Production team members should ensure that the right people look at a pull -request before it is merged. In some cases this may require multiple people to -weigh in. In other cases, only one substantive approval is needed before the -code can be merged. - -In general, try not to merge things based on one review alone, especially if it -is your own. Get a second opinion from another maintainer, and make sure all the -teams that may be impacted have been reasonably represented by the reviewers. -For example, if a pull request adds to the documentation, it's often useful to -let the area maintainers check it for factual correctness and let documentation -maintainers check it for formatting, style, and grammar. - -A good rule of thumb is that at least one subject matter expert should have -approved the pull request for correctness, and at least one other maintainer -should have approved the pull request for code style. Either of those people -could be the person merging the pull request. - -Make sure that the reviews and approvals were left by people competent in that -specific engine area. It is possible that even a long-standing member of the -Godot organization left a review without having the relevant expertise. - -.. note:: - - An easy way to find PRs that may be ready for merging is filtering by - approved PRs and sorting by recently updated. For example, in the main Godot - repository, you can use `this link - `_. - -2. Get feedback from the community -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If a pull request is having trouble attracting reviewers, you may need to reach -out more broadly to ask for help reviewing. Consider asking: - -* the person who reported the bug if the pull request fixes the bug for them, -* contributors who have recently edited that file if they could take a look, or -* a more experienced maintainer from another area if they could provide feedback. - -3. Git checklist -~~~~~~~~~~~~~~~~ - -* **Make sure that the PR comes in one commit.** - - When each commit is self-contained and could be used to build a clean and - working version of the engine, it may be okay to merge a pull request with - multiple commits, but in general, we require that all pull requests only have - one commit. This helps us keep the Git history clean. - -* **Fixes made during the review process must be squashed into - the main commit.** - - For multi-commit PRs check that those fixes are amended in the relevant - commits, and are not just applied on top of everything. - -* **Make sure that the PR has no merge conflicts.** - - Contributors may need to rebase their changes on top of the relevant branch - (e.g. ``master`` or ``3.x``) and manually fix merge conflicts. Even if there - are no merge conflicts, contributors may need to rebase especially old PRs as - the GitHub conflict checker may not catch all conflicts, or the CI may have - changed since it was originally run. - -* **Check for proper commit attribution.** - - If a contributor uses an author signature that is not listed in their GitHub - account, GitHub won't link the merged pull request to their account. This - keeps them from getting proper credit in the GitHub history and makes them - appear like a new contributor on the GitHub UI even after several - contributions. - - Ultimately, it's up to the user if they want to fix it, but they can do so by - authoring the Git commit with the same email they use for their GitHub - account, or by adding the email they used for the Git commit to their GitHub - profile. - -* **Check for proper commit messages.** - - While we don't have a very strict ruleset for commit messages, we still - require them to be short yet descriptive and use proper English. As a - maintainer you've probably written them enough times to know how to make one, - but for a general template think about *"Fix in "*. - For a more detailed recommendation see the `contributing.md - `_ - page in the main Godot repository. - -4. GitHub checklist -~~~~~~~~~~~~~~~~~~~ - -* **Validate the target branch of the PR.** - - Most Godot development happens around in the ``master`` branch. Therefore most - pull requests must be made against it. From there pull requests can then be - backported to other branches. Be wary of people making PRs on the version they - are using (e.g, ``3.3``) and guide them to make a change against a - higher-order branch (e.g. ``3.x``). If the change is not applicable for the - ``master`` branch, the initial PR can be made against the current maintenance - branch, such as ``3.x``. It's okay for people to make multiple PRs for each - target branch, especially if the changes cannot be easily backported. - Cherry-picking is also an option, if possible. Use the appropriate labels if - the PR can be cherrypicked (e.g. ``cherrypick:3.x``). - -.. note:: - - It is possible to change the target branch of the PR, that has already been - submitted, but be aware of the consequences. As it cannot be synchronized - with the push, the target branch change will inevitable tag the entire list - of maintainers for review. It may also render the CI incapable of running - properly. A push should help with that, but if nothing else, recommend - opening a new, fresh PR. - -* **Make sure that the appropriate milestone is assigned.** - - This will make it more obvious which version would include the submitted - changes, should the pull request be merged now. Note, that the milestone is - not a binding contract and does not guarantee that this version is definitely - going to include the PR. If the pull request is not merged before the version - is released, the milestone will be moved (and the PR itself may require a - target branch change). - - Similarly, when merging a PR with a higher milestone than the current version, - or a "wildcard" milestone (e.g. "4.x"), ensure to update the milestone to the - current version. - -* **Make sure that the opening message of the PR contains the - magic words "Closes #..." or "Fixes #...".** - - These link the PR and the referenced issue together and allow GitHub to - auto-close the latter when you merge the changes. Note, that this only works - for the PRs that target the ``master`` branch. For others you need to pay - attention and close the related issues manually. Do it with *"Fixed by #..."* - or *"Resolved by #..."* comment to clearly indicate the act for future - contributors. - -* **For the issues that get closed by the PR add the closest - relevant milestone.** - - In other words, if the PR is targeting the ``master`` branch, but is then also - cherrypicked for ``3.x``, the next ``3.x`` release would be the appropriate - milestone for the closed issue. - -5. Merge the pull request -~~~~~~~~~~~~~~~~~~~~~~~~~ - -If it is appropriate for you to be merging a pull request (i.e. you are on the -production team or you are the team leader for that area), you are confident -that the pull request has been sufficiently reviewed, and once you carry out -these steps you can go ahead and merge the pull request. diff --git a/contributing/workflow/pr_workflow.rst b/contributing/workflow/pr_workflow.rst deleted file mode 100644 index 040cdc903..000000000 --- a/contributing/workflow/pr_workflow.rst +++ /dev/null @@ -1,579 +0,0 @@ -.. _doc_pr_workflow: - -Pull request workflow -===================== - -.. highlight:: shell - -The so-called "PR workflow" used by Godot is common to many projects using -Git, and should be familiar to veteran free software contributors. The idea -is that only a small number (if any) commit directly to the *master* branch. -Instead, contributors *fork* the project (i.e. create a copy of it, which -they can modify as they wish), and then use the GitHub interface to request -a *pull* from one of their fork's branches to one branch of the original -(often named *upstream*) repository. - -The resulting *pull request* (PR) can then be reviewed by other contributors, -which might approve it, reject it, or most often request that modifications -be done. Once approved, the PR can then be merged by one of the core -developers, and its commit(s) will become part of the target branch (usually -the *master* branch). - -We will go together through an example to show the typical workflow and -associated Git commands. But first, let's have a quick look at the -organization of Godot's Git repository. - -Git source repository ---------------------- - -The `repository on GitHub `_ is a -`Git `_ code repository together with an embedded -issue tracker and PR system. - -.. note:: If you are contributing to the documentation, its repository can - be found `here `_. - -The Git version control system is the tool used to keep track of successive -edits to the source code - to contribute efficiently to Godot, learning the -basics of the Git command line is *highly* recommended. There exist some -graphical interfaces for Git, but they usually encourage users to take bad -habits regarding the Git and PR workflow, and we therefore recommend not to -use them. In particular, we advise not to use GitHub's online editor for code -contributions (although it's tolerated for small fixes or documentation changes) -as it enforces one commit per file and per modification, -which quickly leads to PRs with an unreadable Git history (especially after peer review). - -.. seealso:: The first sections of Git's "Book" are a good introduction to - the tool's philosophy and the various commands you need to - master in your daily workflow. You can read them online on the - `Git SCM `_ website. - You can also try out `GitHub's interactive guide `__. - -The branches on the Git repository are organized as follows: - -- The ``master`` branch is where the development of the next major version - occurs. As a development branch, it can be unstable - and is not meant for use in production. This is where PRs should be done - in priority. -- The stable branches are named after their version, e.g. ``3.1`` and ``2.1``. - They are used to backport bugfixes and enhancements from the ``master`` - branch to the currently maintained stable release (e.g. 3.1.2 or 2.1.6). - As a rule of thumb, the last stable branch is maintained until the next - minor version (e.g. the ``3.0`` branch was maintained until the release of - Godot 3.1). - If you want to make PRs against a maintained stable branch, please check - first if your changes are also relevant for the ``master`` branch, and if so - make the PR for the ``master`` branch in priority. Release managers can then - cherry-pick the fix to a stable branch if relevant. -- There might occasionally be feature branches, usually meant to be merged into - the ``master`` branch at some time. - -Forking and cloning -------------------- - -The first step is to *fork* the `godotengine/godot `_ -repository on GitHub. To do so, you will need to have a GitHub account and to -be logged in. In the top right corner of the repository's GitHub page, you -should see the "Fork" button as shown below: - -.. image:: img/github_fork_button.png - -Click it, and after a while you should be redirected to your own fork of the -Godot repo, with your GitHub username as namespace: - -.. image:: img/github_fork_url.png - -You can then *clone* your fork, i.e. create a local copy of the online -repository (in Git speak, the *origin remote*). If you haven't already, -download Git from `its website `_ if you're using Windows or -macOS, or install it through your package manager if you're using Linux. - -.. note:: If you are on Windows, open Git Bash to type commands. macOS and Linux users - can use their respective terminals. - -To clone your fork from GitHub, use the following command: - -:: - - git clone https://github.com/USERNAME/godot - - -After a little while, you should have a ``godot`` directory in your current -working directory. Move into it using the ``cd`` command: - -:: - - cd godot - -We will start by setting up a reference to the original repository that we forked: - -:: - - git remote add upstream https://github.com/godotengine/godot - git fetch upstream - -This will create a reference named ``upstream`` pointing to the original -``godotengine/godot`` repository. This will be useful when you want to pull new -commits from its ``master`` branch to update your fork. You have another -remote reference named ``origin``, which points to your fork (``USERNAME/godot``). - -You only need to do the above steps once, as long as you keep that local -``godot`` folder (which you can move around if you want, the relevant -metadata is hidden in its ``.git`` subfolder). - -.. note:: *Branch it, pull it, code it, stage it, commit, push it, rebase - it... technologic.* - - This bad take on Daft Punk's *Technologic* shows the general - conception Git beginners have of its workflow: lots of strange - commands to learn by copy and paste, hoping they will work as - expected. And that's actually not a bad way to learn, as long as - you're curious and don't hesitate to question your search engine - when lost, so we will give you the basic commands to know when - working in Git. - -In the following, we will assume as an example that you want to implement a feature in -Godot's Project Manager, which is coded in the ``editor/project_manager.cpp`` -file. - -Branching ---------- - -By default, the ``git clone`` should have put you on the ``master`` branch of -your fork (``origin``). To start your own feature development, we will create -a feature branch: - -:: - - # Create the branch based on the current branch (master) - git branch better-project-manager - - # Change the current branch to the new one - git checkout better-project-manager - -This command is equivalent: - -:: - - # Change the current branch to a new named one, based on the current branch - git checkout -b better-project-manager - -If you want to go back to the ``master`` branch, you'd use: - -:: - - git checkout master - -You can see which branch you are currently on with the ``git branch`` -command: - -:: - - git branch - 2.1 - * better-project-manager - master - -Be sure to always go back to the ``master`` branch before creating a new branch, -as your current branch will be used as the base for the new one. Alternatively, -you can specify a custom base branch after the new branch's name: - -:: - - git checkout -b my-new-feature master - -Updating your branch --------------------- - -This would not be needed the first time (just after you forked the upstream -repository). However, the next time you want to work on something, you will -notice that your fork's ``master`` is several commits behind the upstream -``master`` branch: pull requests from other contributors would have been merged -in the meantime. - -To ensure there won't be conflicts between the feature you develop and the -current upstream ``master`` branch, you will have to update your branch by -*pulling* the upstream branch. - -:: - - git pull --rebase upstream master - -The ``--rebase`` argument will ensure that any local changes that you committed -will be re-applied *on top* of the pulled branch, which is usually what we want -in our PR workflow. This way, when you open a pull request, your own commits will -be the only difference with the upstream ``master`` branch. - -While rebasing, conflicts may arise if your commits modified code that has been -changed in the upstream branch in the meantime. If that happens, Git will stop at -the conflicting commit and will ask you to resolve the conflicts. You can do so -with any text editor, then stage the changes (more on that later), and proceed with -``git rebase --continue``. Repeat the operation if later commits have conflicts too, -until the rebase operation completes. - -If you're unsure about what is going on during a rebase and you panic (no worry, -we all do the first few times), you can abort the rebase with ``git rebase --abort``. -You will then be back to the original state of your branch before calling -``git pull --rebase``. - -.. note:: If you omit the ``--rebase`` argument, you will instead create a merge - commit which tells Git what to make of the two distinct branches. If any - conflicts arise, they would be resolved all at once via this merge commit. - - While this is a valid workflow and the default behavior of ``git pull``, - merge commits within PRs are frowned upon in our PR workflow. We only use - them when merging PRs into the upstream branch. - - The philosophy is that a PR should represent the final stage of the changes - made to the codebase, and we are not interested in mistakes and fixes that - would have been done in intermediate stages before merging. - Git gives us great tools to "rewrite the history" and make it as if we got - things right the first time, and we're happy to use it to ensure that - changes are easy to review and understand long after they have been merged. - -If you have already created a merge commit without using ``rebase``, or -have made any other changes that have resulted in undesired history, the best option -is to use an *interactive rebase* on the upstream branch. See the :ref:`dedicated -section ` for instructions. - -.. tip:: If at any time you want to *reset* a local branch to a given commit or branch, - you can do so with ``git reset --hard `` or - ``git reset --hard /`` (e.g. ``git reset --hard upstream/master``). - - Be warned that this will remove any changes that you might have committed in - this branch. If you ever lose commits by mistake, use the ``git reflog`` command - to find the commit ID of the previous state that you would like to restore, and - use it as argument of ``git reset --hard`` to go back to that state. - -Making changes --------------- - -You would then do your changes to our example's -``editor/project_manager.cpp`` file with your usual development environment -(text editor, IDE, etc.). - -By default, those changes are *unstaged*. The staging area is a layer between -your working directory (where you make your modifications) and the local Git -repository (the commits and all the metadata in the ``.git`` folder). To -bring changes from the working directory to the Git repository, you need to -*stage* them with the ``git add`` command, and then to commit them with the -``git commit`` command. - -There are various commands you should know to review your current work, -before staging it, while it is staged, and after it has been committed. - -- ``git diff`` will show you the current unstaged changes, i.e. the - differences between your working directory and the staging area. -- ``git checkout -- `` will undo the unstaged changes to the given - files. -- ``git add `` will *stage* the changes on the listed files. -- ``git diff --staged`` will show the current staged changes, i.e. the - differences between the staging area and the last commit. -- ``git reset HEAD `` will *unstage* changes to the listed files. -- ``git status`` will show you what are the currently staged and unstaged - modifications. -- ``git commit`` will commit the staged files. It will open a text editor - (you can define the one you want to use with the ``GIT_EDITOR`` environment - variable or the ``core.editor`` setting in your Git configuration) to let you - write a commit log. You can use ``git commit -m "Cool commit log"`` to - write the log directly. -- ``git commit --amend`` lets you amend the last commit with your currently - staged changes (added with ``git add``). This is the best option if you - want to fix a mistake in the last commit (bug, typo, style issue, etc.). -- ``git log`` will show you the last commits of your current branch. If you - did local commits, they should be shown at the top. -- ``git show`` will show you the changes of the last commit. You can also - specify a commit hash to see the changes for that commit. - -That's a lot to memorize! Don't worry, just check this cheat sheet when you -need to make changes, and learn by doing. - -Here's how the shell history could look like on our example: - -:: - - # It's nice to know where you're starting from - git log - - # Do changes to the Project Manager with the nano text editor - nano editor/project_manager.cpp - - # Find an unrelated bug in Control and fix it - nano scene/gui/control.cpp - - # Review changes - git status - git diff - - # We'll do two commits for our unrelated changes, - # starting by the Control changes necessary for the PM enhancements - git add scene/gui/control.cpp - git commit -m "Fix handling of margins in Control" - - # Check we did good - git log - git show - git status - - # Make our second commit - git add editor/project_manager.cpp - git commit -m "Add a pretty banner to the Project Manager" - git log - -With this, we should have two new commits in our ``better-project-manager`` -branch which were not in the ``master`` branch. They are still only local -though, the remote fork does not know about them, nor does the upstream repo. - -Pushing changes to a remote ---------------------------- - -That's where ``git push`` will come into play. In Git, a commit is always -done in the local repository (unlike Subversion where a commit will modify -the remote repository directly). You need to *push* the new commits to a -remote branch to share them with the world. The syntax for this is: - -:: - - git push [:] - -The part about the remote branch can be omitted if you want it to have the -same name as the local branch, which is our case in this example, so we will -do: - -:: - - git push origin better-project-manager - -Git will ask you for your username and password. For your password, enter your -GitHub Personal Access Token (PAT). If you do not have a GitHub Personal Access -Token, or do not have one with the correct permissions for your newly forked -repository, you will need to create one. Follow this link to create your Personal -Access Token: `Creating a personal access token -`_. - -After you have successfully verified your account using your PAT, the changes -will be sent to your remote repository. If you check the fork's page on GitHub, -you should see a new branch with your added commits. - -Issuing a pull request ----------------------- - -When you load your fork's branch on GitHub, you should see a line saying -*"This branch is 2 commits ahead of godotengine:master."* (and potentially some -commits behind, if your ``master`` branch was out of sync with the upstream -``master`` branch). - -.. image:: img/github_fork_make_pr.png - -On that line, there is a "Pull request" link. Clicking it will open a form -that will let you issue a pull request on the ``godotengine/godot`` upstream -repository. It should show you your two commits, and state "Able to merge". -If not (e.g. it has way more commits, or says there are merge conflicts), -don't create the PR yet, something went wrong. Go to our -`Godot Contributors Chat `_ and ask for support :) - -Use an explicit title for the PR and put the necessary details in the comment -area. You can drag and drop screenshots, GIFs or zipped projects if relevant, -to showcase what your work implements. Click "Create a pull request", and -tadaa! - -Modifying a pull request ------------------------- - -While it is reviewed by other contributors, you will often need to make -changes to your yet-unmerged PR, either because contributors requested them, -or because you found issues yourself while testing. - -The good news is that you can modify a pull request simply by acting on the -branch you made the pull request from. You can e.g. make a new commit on that -branch, push it to your fork, and the PR will be updated automatically: - -:: - - # Check out your branch again if you had changed in the meantime - git checkout better-project-manager - - # Fix a mistake - nano editor/project_manager.cpp - git add editor/project_manager.cpp - git commit -m "Fix a typo in the banner's title" - git push origin better-project-manager - -However, be aware that in our PR workflow, we favor commits that bring the -codebase from one functional state to another functional state, without having -intermediate commits fixing up bugs in your own code or style issues. Most of -the time, we will prefer a single commit in a given PR (unless there's a good -reason to keep the changes separate). Instead of authoring a new commit, -consider using ``git commit --amend`` to amend the previous commit with your -fixes. The above example would then become: - -:: - - # Check out your branch again if you had changed in the meantime - git checkout better-project-manager - - # Fix a mistake - nano editor/project_manager.cpp - git add editor/project_manager.cpp - # --amend will change the previous commit, so you will have the opportunity - # to edit its commit message if relevant. - git commit --amend - # As we modified the last commit, it no longer matches the one from your - # remote branch, so we need to force push to overwrite that branch. - git push --force origin better-project-manager - -.. Kept for compatibility with the previous title, linked in many PRs. - -.. _mastering-the-pr-workflow-the-rebase: - -.. _doc_pr_workflow_rebase: - -The interactive rebase ----------------------- - -If you didn't follow the above steps closely to *amend* changes into a commit -instead of creating fixup commits, or if you authored your changes without being -aware of our workflow and Git usage tips, reviewers might request you to -*rebase* your branch to *squash* some or all of the commits into one. - -Indeed, if some commits have been made following reviews to fix bugs, typos, etc. -in the original commit, they are not relevant to a future changelog reader who -would want to know what happened in the Godot codebase, or when and how a given -file was last modified. - -To squash those extraneous commits into the main one, we will have to *rewrite -history*. Right, we have that power. You may read that it's a bad practice, and -it's true when it comes to branches of the upstream repo. But in your fork, you -can do whatever you want, and everything is allowed to get neat PRs :) - -We will use the *interactive rebase* ``git rebase -i`` to do this. This -command takes a commit ID or a branch name as argument, and will let you modify -all commits between that commit/branch and the last one in your working branch, -the so-called ``HEAD``. - -While you can give any commit ID to ``git rebase -i`` and review everything in -between, the most common and convenient workflow involves rebasing on the -upstream ``master`` branch, which you can do with: - -:: - - git rebase -i upstream/master - -.. note:: Referencing branches in Git is a bit tricky due to the distinction - between remote and local branches. Here, ``upstream/master`` (with a - `/`) is a local branch which has been pulled from the ``upstream`` - remote's ``master`` branch. - - Interactive rebases can only be done on local branches, so the `/` - is important here. As the upstream remote changes frequently, your - local ``upstream/master`` branch may become outdated, so you can - update it with ``git fetch upstream master``. Contrarily to - ``git pull --rebase upstream master`` which would update your - currently checked out branch, ``fetch`` will only update the - ``upstream/master`` reference (which is distinct from your local - ``master`` branch... yes it's confusing, but you'll become familiar - with this little by little). - -This will open a text editor (``vi`` by default, see -`Git docs `_ -to configure your favorite one) with something which may look like this: - -.. code-block:: text - - pick 1b4aad7 Add a pretty banner to the Project Manager - pick e07077e Fix a typo in the banner's title - -The editor will also show instructions regarding how you can act on those -commits. In particular, it should tell you that "pick" means to use that -commit (do nothing), and that "squash" and "fixup" can be used to *meld* the -commit in its parent commit. The difference between "squash" and "fixup" is -that "fixup" will discard the commit log from the squashed commit. In our -example, we are not interested in keeping the log of the "Fix a typo" commit, -so we use: - -.. code-block:: text - - pick 1b4aad7 Add a pretty banner to the Project Manager - fixup e07077e Fix a typo in the banner's title - -Upon saving and quitting the editor, the rebase will occur. The second commit -will be melded into the first one, and ``git log`` and ``git show`` should -now confirm that you have only one commit with the changes from both previous -commits. - -But! You rewrote the history, and now your local and remote branches have -diverged. Indeed, commit 1b4aad7 in the above example will have changed, and -therefore got a new commit hash. If you try to push to your remote branch, it -will raise an error: - -:: - - git push origin better-project-manager - To https://github.com/akien-mga/godot - ! [rejected] better-project-manager -> better-project-manager (non-fast-forward) - error: failed to push some refs to 'https://akien-mga@github.com/akien-mga/godot' - hint: Updates were rejected because the tip of your current branch is behind - hint: its remote counterpart. - -This is reasonable behavior, Git will not let you push changes that would -override remote content. But that's actually what we want to do here, so we -will have to *force* it: - -:: - - git push --force origin better-project-manager - -And tadaa! Git will happily *replace* your remote branch with what you had -locally (so make sure that's what you wanted, using ``git log``). This will -also update the PR accordingly. - -Rebasing onto another branch ----------------------------- - -If you have accidentally opened your PR on the wrong branch, or need to target another branch -for some reason, you might need to filter out a lot of commits that differ between the old branch -(for example ``4.2``) and the new branch (for example ``master``). This can make rebasing difficult -and tedious. Fortunately ``git`` has a command just for this situation, ``git rebase --onto``. - -If your PR was created from the ``4.2`` branch and you want to update it to instead start at ``master`` -the following steps *should* fix this in one step: - -.. code-block:: text - - git rebase -i --onto master 4.2 - -This will take all the commits on your branch *after* the ``4.2`` branch, and then splice them on top of ``master``, -ignoring any commits from the ``4.2`` branch not on the ``master`` branch. You may still need to do some fixing, but -this command should save you a lot of tedious work removing commits. - -Just like above for the interactive rebase you need to force push your branch to handle the different changes: - -:: - - git push --force origin better-project-manager - -Deleting a Git branch ---------------------- - -After your pull request gets merged, there's one last thing you should do: delete your -Git branch for the PR. There won't be issues if you don't delete your branch, but it's -good practice to do so. You'll need to do this twice, once for the local branch and another -for the remote branch on GitHub. - -To delete our better Project Manager branch locally, use this command: - -:: - - git branch -d better-project-manager - -Alternatively, if the branch hadn't been merged yet and we wanted to delete it anyway, instead -of ``-d`` you would use ``-D``. - -Next, to delete the remote branch on GitHub use this command: - -:: - - git push origin -d better-project-manager - -You can also delete the remote branch from the GitHub PR itself, a button should appear once -it has been merged or closed. diff --git a/contributing/workflow/testing_pull_requests.rst b/contributing/workflow/testing_pull_requests.rst deleted file mode 100644 index 75ce55be8..000000000 --- a/contributing/workflow/testing_pull_requests.rst +++ /dev/null @@ -1,137 +0,0 @@ -.. _doc_testing_pull_requests: - -Testing pull requests -===================== - -Many people are developing new features or fixing bugs on GitHub. -To help with engine development, you may be asked to test those pull requests -with a Godot build that includes code from the pull request in question. - -Thanks to GitHub Actions, all `pull requests `__ -have continuous builds available. These builds let you try out pull requests -without having to compile anything from source. - -Downloading a compiled build ----------------------------- - -You can download pull request builds from GitHub Actions. Since only signed in -users may download builds directly from GitHub Actions, the procedure varies -depending on whether you have a GitHub account or not. - -.. note:: - - Due to a GitHub Actions limitation, builds are only available for 90 days - after the pull request was last updated. If you still wish to try a - pull request locally, you can - :ref:`compile the pull request branch from source ` - instead. - -If you have a GitHub account -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- Open the pull request page. Click the **Checks** tab near the top of the page: - -.. image:: img/testing_pull_requests_access_checks.webp - -- Click the **Artifacts** dropdown on the right of the page: - -.. image:: img/testing_pull_requests_checks_artifacts.webp - -- In the dropdown, click the artifact's name to download it. Remember to scroll - if you cannot see the name of the platform you're looking for: - -.. image:: img/testing_pull_requests_checks_artifacts_list.webp - -- Extract the ZIP archive then run the executable. - Note that Windows and macOS binaries are **not** code signed. - This means you may have to bypass a security warning before you can run the executable. - On Windows, if you frequently test pull request builds, it may be better to disable - Windows SmartScreen permanently in the Windows security settings. - On macOS, see :ref:`doc_running_on_macos` for instructions on bypassing Gatekeeper. - -If you don't have a GitHub account -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you don't have a GitHub account and can't sign up for one, -you can use the third-party `nightly.link `__ service -to generate a universal download link. - -- Open the pull request page. Click the *fork*'s branch name near the top of the page: - -.. image:: img/testing_pull_requests_access_fork.png - -- Now that you are on the fork's branch page, click the ``.github`` folder at the top of the file list. - Then, click on the ``workflows`` folder (which is inside the ``.github`` folder). - Click the workflow file for the platform you wish to download artifacts for. - *After* clicking on the file (which opens the file view), copy the page URL from your browser's address bar. - -- Open the `nightly.link `__ website and paste the URL you just copied - into the text field located below the heading **Paste a GitHub link, get a nightly.link!**. - After pasting the URL, click **Get links** on the right. - If the format of the URL you pasted is correct, you should be presented - with a page like this: - -.. image:: img/testing_pull_requests_nightly_link.png - -- Click the URL of the artifact you wish to download. - -- Extract the ZIP archive then run the executable. - Note that Windows and macOS binaries are not code signed. - This means you may have to bypass a security warning before you can run the executable. - If you frequently test pull request builds, it may be better to disable - Windows SmartScreen or `disable macOS Gatekeeper `__ permanently. - -.. _doc_testing_pull_requests_compile: - -Compiling a pull request branch from source -------------------------------------------- - -This approach may be needed for pull requests that were last updated more than -90 days ago, or to test on platforms and configurations that are not supported -by Godot's GitHub Actions setup. - -Downloading a zipped pull request branch -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- Open the pull request page. Click the *fork*'s branch name near the top of the page: - -.. image:: img/testing_pull_requests_access_fork.png - -- Now that you are on the fork's branch page, click the green **Code** button on the right of the page - then choose **Download ZIP** in the dropdown: - -.. image:: img/testing_pull_requests_fork_zip.png - -- Extract the ZIP archive and follow the :ref:`compiling ` instructions - for your operating system. - -Checking out a pull request branch with git -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Alternatively, you can checkout the pull request directly with git: - -- Open the pull request page. Note the pull request *number* (``PR_NUMBER``), and the *branch name* - (``BRANCH_NAME``), but without the user name. - -.. image:: img/testing_pull_requests_command_line_checkout.webp - -- Construct the command using this pattern: - -:: - - git fetch upstream pull/PR_NUMBER/head:BRANCH_NAME - -So for the pull request above, the actual command will be: - -:: - - # Fetch PR branch locally - git fetch upstream pull/48734/head:editor_file_dialog_filter_sort - -- Once the pull request finishes downloading, checkout its branch: - -:: - - git checkout editor_file_dialog_filter_sort - -- And follow the :ref:`compiling ` instructions for your operating system. diff --git a/contributing/development/core_and_modules/2d_coordinate_systems.rst b/engine_details/architecture/2d_coordinate_systems.rst similarity index 100% rename from contributing/development/core_and_modules/2d_coordinate_systems.rst rename to engine_details/architecture/2d_coordinate_systems.rst diff --git a/contributing/development/core_and_modules/binding_to_external_libraries.rst b/engine_details/architecture/binding_to_external_libraries.rst similarity index 100% rename from contributing/development/core_and_modules/binding_to_external_libraries.rst rename to engine_details/architecture/binding_to_external_libraries.rst diff --git a/contributing/development/core_and_modules/common_engine_methods_and_macros.rst b/engine_details/architecture/common_engine_methods_and_macros.rst similarity index 100% rename from contributing/development/core_and_modules/common_engine_methods_and_macros.rst rename to engine_details/architecture/common_engine_methods_and_macros.rst diff --git a/contributing/development/core_and_modules/core_types.rst b/engine_details/architecture/core_types.rst similarity index 100% rename from contributing/development/core_and_modules/core_types.rst rename to engine_details/architecture/core_types.rst diff --git a/contributing/development/core_and_modules/custom_audiostreams.rst b/engine_details/architecture/custom_audiostreams.rst similarity index 100% rename from contributing/development/core_and_modules/custom_audiostreams.rst rename to engine_details/architecture/custom_audiostreams.rst diff --git a/contributing/development/core_and_modules/custom_godot_servers.rst b/engine_details/architecture/custom_godot_servers.rst similarity index 100% rename from contributing/development/core_and_modules/custom_godot_servers.rst rename to engine_details/architecture/custom_godot_servers.rst diff --git a/contributing/development/core_and_modules/custom_modules_in_cpp.rst b/engine_details/architecture/custom_modules_in_cpp.rst similarity index 99% rename from contributing/development/core_and_modules/custom_modules_in_cpp.rst rename to engine_details/architecture/custom_modules_in_cpp.rst index 94cf5f16f..6b7b625bd 100644 --- a/contributing/development/core_and_modules/custom_modules_in_cpp.rst +++ b/engine_details/architecture/custom_modules_in_cpp.rst @@ -569,7 +569,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 :ref:`doc_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/contributing/development/core_and_modules/custom_platform_ports.rst b/engine_details/architecture/custom_platform_ports.rst similarity index 100% rename from contributing/development/core_and_modules/custom_platform_ports.rst rename to engine_details/architecture/custom_platform_ports.rst diff --git a/contributing/development/core_and_modules/custom_resource_format_loaders.rst b/engine_details/architecture/custom_resource_format_loaders.rst similarity index 100% rename from contributing/development/core_and_modules/custom_resource_format_loaders.rst rename to engine_details/architecture/custom_resource_format_loaders.rst diff --git a/contributing/development/core_and_modules/files/class_tree.zip b/engine_details/architecture/files/class_tree.zip similarity index 100% rename from contributing/development/core_and_modules/files/class_tree.zip rename to engine_details/architecture/files/class_tree.zip diff --git a/contributing/development/core_and_modules/godot_architecture_diagram.rst b/engine_details/architecture/godot_architecture_diagram.rst similarity index 100% rename from contributing/development/core_and_modules/godot_architecture_diagram.rst rename to engine_details/architecture/godot_architecture_diagram.rst diff --git a/contributing/development/core_and_modules/img/Control.webp b/engine_details/architecture/img/Control.webp similarity index 100% rename from contributing/development/core_and_modules/img/Control.webp rename to engine_details/architecture/img/Control.webp diff --git a/contributing/development/core_and_modules/img/Node2D.png b/engine_details/architecture/img/Node2D.png similarity index 100% rename from contributing/development/core_and_modules/img/Node2D.png rename to engine_details/architecture/img/Node2D.png diff --git a/contributing/development/core_and_modules/img/Node2D.webp b/engine_details/architecture/img/Node2D.webp similarity index 100% rename from contributing/development/core_and_modules/img/Node2D.webp rename to engine_details/architecture/img/Node2D.webp diff --git a/contributing/development/core_and_modules/img/Node3D.webp b/engine_details/architecture/img/Node3D.webp similarity index 100% rename from contributing/development/core_and_modules/img/Node3D.webp rename to engine_details/architecture/img/Node3D.webp diff --git a/contributing/development/core_and_modules/img/Object.webp b/engine_details/architecture/img/Object.webp similarity index 100% rename from contributing/development/core_and_modules/img/Object.webp rename to engine_details/architecture/img/Object.webp diff --git a/contributing/development/core_and_modules/img/RefCounted.webp b/engine_details/architecture/img/RefCounted.webp similarity index 100% rename from contributing/development/core_and_modules/img/RefCounted.webp rename to engine_details/architecture/img/RefCounted.webp diff --git a/contributing/development/core_and_modules/img/architecture_diagram.jpg b/engine_details/architecture/img/architecture_diagram.jpg similarity index 100% rename from contributing/development/core_and_modules/img/architecture_diagram.jpg rename to engine_details/architecture/img/architecture_diagram.jpg diff --git a/contributing/development/core_and_modules/img/rendering_architecture_diagram.webp b/engine_details/architecture/img/rendering_architecture_diagram.webp similarity index 100% rename from contributing/development/core_and_modules/img/rendering_architecture_diagram.webp rename to engine_details/architecture/img/rendering_architecture_diagram.webp diff --git a/contributing/development/core_and_modules/img/transforms_overview.webp b/engine_details/architecture/img/transforms_overview.webp similarity index 100% rename from contributing/development/core_and_modules/img/transforms_overview.webp rename to engine_details/architecture/img/transforms_overview.webp diff --git a/contributing/development/core_and_modules/index.rst b/engine_details/architecture/index.rst similarity index 95% rename from contributing/development/core_and_modules/index.rst rename to engine_details/architecture/index.rst index e4d944728..795f7a4d1 100644 --- a/contributing/development/core_and_modules/index.rst +++ b/engine_details/architecture/index.rst @@ -1,7 +1,7 @@ :allow_comments: False -Engine core and modules -======================= +Engine architecture +=================== The following pages are meant to introduce the global organization of Godot Engine's source code, and give useful tips for extending and fixing the engine on the C++ side. diff --git a/contributing/development/core_and_modules/inheritance_class_tree.rst b/engine_details/architecture/inheritance_class_tree.rst similarity index 100% rename from contributing/development/core_and_modules/inheritance_class_tree.rst rename to engine_details/architecture/inheritance_class_tree.rst diff --git a/contributing/development/core_and_modules/internal_rendering_architecture.rst b/engine_details/architecture/internal_rendering_architecture.rst similarity index 99% rename from contributing/development/core_and_modules/internal_rendering_architecture.rst rename to engine_details/architecture/internal_rendering_architecture.rst index 1c2310ab2..98968abd9 100644 --- a/contributing/development/core_and_modules/internal_rendering_architecture.rst +++ b/engine_details/architecture/internal_rendering_architecture.rst @@ -7,7 +7,7 @@ This page is a high-level overview of Godot 4's internal renderer design. It does not apply to previous Godot versions. The goal of this page is to document design decisions taken to best suit -:ref:`Godot's design philosophy `, +`Godot's design philosophy `__, while providing a starting point for new rendering contributors. If you have questions about rendering internals not answered here, feel free to diff --git a/contributing/development/core_and_modules/object_class.rst b/engine_details/architecture/object_class.rst similarity index 100% rename from contributing/development/core_and_modules/object_class.rst rename to engine_details/architecture/object_class.rst diff --git a/contributing/development/core_and_modules/scripting_development.rst b/engine_details/architecture/scripting_development.rst similarity index 100% rename from contributing/development/core_and_modules/scripting_development.rst rename to engine_details/architecture/scripting_development.rst diff --git a/contributing/development/core_and_modules/unit_testing.rst b/engine_details/architecture/unit_testing.rst similarity index 100% rename from contributing/development/core_and_modules/unit_testing.rst rename to engine_details/architecture/unit_testing.rst diff --git a/contributing/development/core_and_modules/variant_class.rst b/engine_details/architecture/variant_class.rst similarity index 100% rename from contributing/development/core_and_modules/variant_class.rst rename to engine_details/architecture/variant_class.rst diff --git a/contributing/documentation/class_reference_primer.rst b/engine_details/class_reference/index.rst similarity index 98% rename from contributing/documentation/class_reference_primer.rst rename to engine_details/class_reference/index.rst index 2e15c66f7..9022a28f8 100644 --- a/contributing/documentation/class_reference_primer.rst +++ b/engine_details/class_reference/index.rst @@ -10,7 +10,7 @@ built-in node types. .. seealso:: To learn to submit your changes to the Godot project using the Git version - control system, see :ref:`doc_updating_the_class_reference`. + control system, see `Class reference contribution documentation `__. The reference for each class is contained in an XML file like the one below: @@ -79,8 +79,9 @@ their documentation by completing or improving the text in these tags: - `` (in its `` tag; arguments don't take separate documentation strings) - `` -Write in a clear and simple language. Always follow the :ref:`writing guidelines -` to keep your descriptions short and easy to read. +Write in a clear and simple language. Always follow the `writing guidelines +`__ +to keep your descriptions short and easy to read. **Do not leave empty lines** in the descriptions: each line in the XML file will result in a new paragraph, even if it is empty. diff --git a/contributing/development/compiling/compiling_for_android.rst b/engine_details/development/compiling/compiling_for_android.rst similarity index 100% rename from contributing/development/compiling/compiling_for_android.rst rename to engine_details/development/compiling/compiling_for_android.rst diff --git a/contributing/development/compiling/compiling_for_ios.rst b/engine_details/development/compiling/compiling_for_ios.rst similarity index 100% rename from contributing/development/compiling/compiling_for_ios.rst rename to engine_details/development/compiling/compiling_for_ios.rst diff --git a/contributing/development/compiling/compiling_for_linuxbsd.rst b/engine_details/development/compiling/compiling_for_linuxbsd.rst similarity index 100% rename from contributing/development/compiling/compiling_for_linuxbsd.rst rename to engine_details/development/compiling/compiling_for_linuxbsd.rst diff --git a/contributing/development/compiling/compiling_for_macos.rst b/engine_details/development/compiling/compiling_for_macos.rst similarity index 100% rename from contributing/development/compiling/compiling_for_macos.rst rename to engine_details/development/compiling/compiling_for_macos.rst diff --git a/contributing/development/compiling/compiling_for_visionos.rst b/engine_details/development/compiling/compiling_for_visionos.rst similarity index 93% rename from contributing/development/compiling/compiling_for_visionos.rst rename to engine_details/development/compiling/compiling_for_visionos.rst index 07211dbd2..b83a5c2aa 100644 --- a/contributing/development/compiling/compiling_for_visionos.rst +++ b/engine_details/development/compiling/compiling_for_visionos.rst @@ -11,4 +11,4 @@ Compiling for visionOS Compiling instructions for visionOS are currently identical to :ref:`doc_compiling_for_ios`, except you should replace instances of ``platform=ios`` with ``platform=visionos`` in the SCons options. -See the linked page for details. +See the linked page for details. \ No newline at end of file diff --git a/contributing/development/compiling/compiling_for_web.rst b/engine_details/development/compiling/compiling_for_web.rst similarity index 100% rename from contributing/development/compiling/compiling_for_web.rst rename to engine_details/development/compiling/compiling_for_web.rst diff --git a/contributing/development/compiling/compiling_for_windows.rst b/engine_details/development/compiling/compiling_for_windows.rst similarity index 100% rename from contributing/development/compiling/compiling_for_windows.rst rename to engine_details/development/compiling/compiling_for_windows.rst diff --git a/contributing/development/compiling/compiling_with_dotnet.rst b/engine_details/development/compiling/compiling_with_dotnet.rst similarity index 100% rename from contributing/development/compiling/compiling_with_dotnet.rst rename to engine_details/development/compiling/compiling_with_dotnet.rst diff --git a/contributing/development/compiling/compiling_with_script_encryption_key.rst b/engine_details/development/compiling/compiling_with_script_encryption_key.rst similarity index 100% rename from contributing/development/compiling/compiling_with_script_encryption_key.rst rename to engine_details/development/compiling/compiling_with_script_encryption_key.rst diff --git a/contributing/development/compiling/cross-compiling_for_ios_on_linux.rst b/engine_details/development/compiling/cross-compiling_for_ios_on_linux.rst similarity index 100% rename from contributing/development/compiling/cross-compiling_for_ios_on_linux.rst rename to engine_details/development/compiling/cross-compiling_for_ios_on_linux.rst diff --git a/contributing/development/compiling/getting_source.rst b/engine_details/development/compiling/getting_source.rst similarity index 94% rename from contributing/development/compiling/getting_source.rst rename to engine_details/development/compiling/getting_source.rst index 7182407e4..ea49d29fa 100644 --- a/contributing/development/compiling/getting_source.rst +++ b/engine_details/development/compiling/getting_source.rst @@ -16,7 +16,7 @@ and while you can manually download it via the website, in general you want to do it via the ``git`` version control system. If you are compiling in order to make contributions or pull requests, you should -follow the instructions from the :ref:`Pull Request workflow `. +follow the instructions from the `Pull Request workflow `__. If you don't know much about ``git`` yet, there are a great number of `tutorials `__ available on various websites. diff --git a/contributing/development/compiling/img/andtemplates.webp b/engine_details/development/compiling/img/andtemplates.webp similarity index 100% rename from contributing/development/compiling/img/andtemplates.webp rename to engine_details/development/compiling/img/andtemplates.webp diff --git a/contributing/development/compiling/img/encryption_key.png b/engine_details/development/compiling/img/encryption_key.png similarity index 100% rename from contributing/development/compiling/img/encryption_key.png rename to engine_details/development/compiling/img/encryption_key.png diff --git a/contributing/development/compiling/img/lintemplates.webp b/engine_details/development/compiling/img/lintemplates.webp similarity index 100% rename from contributing/development/compiling/img/lintemplates.webp rename to engine_details/development/compiling/img/lintemplates.webp diff --git a/contributing/development/compiling/img/wintemplates.webp b/engine_details/development/compiling/img/wintemplates.webp similarity index 100% rename from contributing/development/compiling/img/wintemplates.webp rename to engine_details/development/compiling/img/wintemplates.webp diff --git a/contributing/development/compiling/index.rst b/engine_details/development/compiling/index.rst similarity index 100% rename from contributing/development/compiling/index.rst rename to engine_details/development/compiling/index.rst diff --git a/contributing/development/compiling/introduction_to_the_buildsystem.rst b/engine_details/development/compiling/introduction_to_the_buildsystem.rst similarity index 100% rename from contributing/development/compiling/introduction_to_the_buildsystem.rst rename to engine_details/development/compiling/introduction_to_the_buildsystem.rst diff --git a/contributing/development/compiling/optimizing_for_size.rst b/engine_details/development/compiling/optimizing_for_size.rst similarity index 100% rename from contributing/development/compiling/optimizing_for_size.rst rename to engine_details/development/compiling/optimizing_for_size.rst diff --git a/contributing/development/configuring_an_ide/android_studio.rst b/engine_details/development/configuring_an_ide/android_studio.rst similarity index 100% rename from contributing/development/configuring_an_ide/android_studio.rst rename to engine_details/development/configuring_an_ide/android_studio.rst diff --git a/contributing/development/configuring_an_ide/clion.rst b/engine_details/development/configuring_an_ide/clion.rst similarity index 100% rename from contributing/development/configuring_an_ide/clion.rst rename to engine_details/development/configuring_an_ide/clion.rst diff --git a/contributing/development/configuring_an_ide/code_blocks.rst b/engine_details/development/configuring_an_ide/code_blocks.rst similarity index 93% rename from contributing/development/configuring_an_ide/code_blocks.rst rename to engine_details/development/configuring_an_ide/code_blocks.rst index 6d0fe1997..7c91ce29c 100644 --- a/contributing/development/configuring_an_ide/code_blocks.rst +++ b/engine_details/development/configuring_an_ide/code_blocks.rst @@ -114,7 +114,7 @@ It should automatically select the project folder; so simply click **Open**. By Code style configuration ------------------------ -Before editing any files, remember that all code needs to comply with the :ref:`doc_code_style_guidelines`. One important difference with Godot is the use of tabs for indents. Therefore, the key default editor setting that needs to be changed in Code::Blocks is to enable tabs for indents. This setting can be found by selecting **Settings > Editor**. +Before editing any files, remember that all code needs to comply with the `code style guidelines `__. One important difference with Godot is the use of tabs for indents. Therefore, the key default editor setting that needs to be changed in Code::Blocks is to enable tabs for indents. This setting can be found by selecting **Settings > Editor**. .. figure:: img/code_blocks_update_editor_settings.png :figclass: figure-w480 diff --git a/contributing/development/configuring_an_ide/img/android_studio_app_build_variant.webp b/engine_details/development/configuring_an_ide/img/android_studio_app_build_variant.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/android_studio_app_build_variant.webp rename to engine_details/development/configuring_an_ide/img/android_studio_app_build_variant.webp diff --git a/contributing/development/configuring_an_ide/img/android_studio_app_configurations_drop_down.webp b/engine_details/development/configuring_an_ide/img/android_studio_app_configurations_drop_down.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/android_studio_app_configurations_drop_down.webp rename to engine_details/development/configuring_an_ide/img/android_studio_app_configurations_drop_down.webp diff --git a/contributing/development/configuring_an_ide/img/android_studio_app_debug_type_setup.webp b/engine_details/development/configuring_an_ide/img/android_studio_app_debug_type_setup.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/android_studio_app_debug_type_setup.webp rename to engine_details/development/configuring_an_ide/img/android_studio_app_debug_type_setup.webp diff --git a/contributing/development/configuring_an_ide/img/android_studio_editor_build_variant.webp b/engine_details/development/configuring_an_ide/img/android_studio_editor_build_variant.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/android_studio_editor_build_variant.webp rename to engine_details/development/configuring_an_ide/img/android_studio_editor_build_variant.webp diff --git a/contributing/development/configuring_an_ide/img/android_studio_editor_configurations_drop_down.webp b/engine_details/development/configuring_an_ide/img/android_studio_editor_configurations_drop_down.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/android_studio_editor_configurations_drop_down.webp rename to engine_details/development/configuring_an_ide/img/android_studio_editor_configurations_drop_down.webp diff --git a/contributing/development/configuring_an_ide/img/android_studio_editor_debug_type_setup.webp b/engine_details/development/configuring_an_ide/img/android_studio_editor_debug_type_setup.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/android_studio_editor_debug_type_setup.webp rename to engine_details/development/configuring_an_ide/img/android_studio_editor_debug_type_setup.webp diff --git a/contributing/development/configuring_an_ide/img/android_studio_setup_project_1.png b/engine_details/development/configuring_an_ide/img/android_studio_setup_project_1.png similarity index 100% rename from contributing/development/configuring_an_ide/img/android_studio_setup_project_1.png rename to engine_details/development/configuring_an_ide/img/android_studio_setup_project_1.png diff --git a/contributing/development/configuring_an_ide/img/clion-add-configuration.png b/engine_details/development/configuring_an_ide/img/clion-add-configuration.png similarity index 100% rename from contributing/development/configuring_an_ide/img/clion-add-configuration.png rename to engine_details/development/configuring_an_ide/img/clion-add-configuration.png diff --git a/contributing/development/configuring_an_ide/img/clion-add-custom-build-application.png b/engine_details/development/configuring_an_ide/img/clion-add-custom-build-application.png similarity index 100% rename from contributing/development/configuring_an_ide/img/clion-add-custom-build-application.png rename to engine_details/development/configuring_an_ide/img/clion-add-custom-build-application.png diff --git a/contributing/development/configuring_an_ide/img/clion-build-run.png b/engine_details/development/configuring_an_ide/img/clion-build-run.png similarity index 100% rename from contributing/development/configuring_an_ide/img/clion-build-run.png rename to engine_details/development/configuring_an_ide/img/clion-build-run.png diff --git a/contributing/development/configuring_an_ide/img/clion-create-build-tool.webp b/engine_details/development/configuring_an_ide/img/clion-create-build-tool.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/clion-create-build-tool.webp rename to engine_details/development/configuring_an_ide/img/clion-create-build-tool.webp diff --git a/contributing/development/configuring_an_ide/img/clion-create-clean-tool.png b/engine_details/development/configuring_an_ide/img/clion-create-clean-tool.png similarity index 100% rename from contributing/development/configuring_an_ide/img/clion-create-clean-tool.png rename to engine_details/development/configuring_an_ide/img/clion-create-clean-tool.png diff --git a/contributing/development/configuring_an_ide/img/clion-external-tools.png b/engine_details/development/configuring_an_ide/img/clion-external-tools.png similarity index 100% rename from contributing/development/configuring_an_ide/img/clion-external-tools.png rename to engine_details/development/configuring_an_ide/img/clion-external-tools.png diff --git a/contributing/development/configuring_an_ide/img/clion-ignore-object-library-files.webp b/engine_details/development/configuring_an_ide/img/clion-ignore-object-library-files.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/clion-ignore-object-library-files.webp rename to engine_details/development/configuring_an_ide/img/clion-ignore-object-library-files.webp diff --git a/contributing/development/configuring_an_ide/img/clion-object-library-files-in-project-view.webp b/engine_details/development/configuring_an_ide/img/clion-object-library-files-in-project-view.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/clion-object-library-files-in-project-view.webp rename to engine_details/development/configuring_an_ide/img/clion-object-library-files-in-project-view.webp diff --git a/contributing/development/configuring_an_ide/img/clion-preferences.png b/engine_details/development/configuring_an_ide/img/clion-preferences.png similarity index 100% rename from contributing/development/configuring_an_ide/img/clion-preferences.png rename to engine_details/development/configuring_an_ide/img/clion-preferences.png diff --git a/contributing/development/configuring_an_ide/img/clion-run-configuration.png b/engine_details/development/configuring_an_ide/img/clion-run-configuration.png similarity index 100% rename from contributing/development/configuring_an_ide/img/clion-run-configuration.png rename to engine_details/development/configuring_an_ide/img/clion-run-configuration.png diff --git a/contributing/development/configuring_an_ide/img/clion-select-tools.png b/engine_details/development/configuring_an_ide/img/clion-select-tools.png similarity index 100% rename from contributing/development/configuring_an_ide/img/clion-select-tools.png rename to engine_details/development/configuring_an_ide/img/clion-select-tools.png diff --git a/contributing/development/configuring_an_ide/img/clion-target.png b/engine_details/development/configuring_an_ide/img/clion-target.png similarity index 100% rename from contributing/development/configuring_an_ide/img/clion-target.png rename to engine_details/development/configuring_an_ide/img/clion-target.png diff --git a/contributing/development/configuring_an_ide/img/clion_visual_studio_toolchain.webp b/engine_details/development/configuring_an_ide/img/clion_visual_studio_toolchain.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/clion_visual_studio_toolchain.webp rename to engine_details/development/configuring_an_ide/img/clion_visual_studio_toolchain.webp diff --git a/contributing/development/configuring_an_ide/img/code_block_use_tab_character.png b/engine_details/development/configuring_an_ide/img/code_block_use_tab_character.png similarity index 100% rename from contributing/development/configuring_an_ide/img/code_block_use_tab_character.png rename to engine_details/development/configuring_an_ide/img/code_block_use_tab_character.png diff --git a/contributing/development/configuring_an_ide/img/code_blocks_add_files_recursively.png b/engine_details/development/configuring_an_ide/img/code_blocks_add_files_recursively.png similarity index 100% rename from contributing/development/configuring_an_ide/img/code_blocks_add_files_recursively.png rename to engine_details/development/configuring_an_ide/img/code_blocks_add_files_recursively.png diff --git a/contributing/development/configuring_an_ide/img/code_blocks_build_targets.png b/engine_details/development/configuring_an_ide/img/code_blocks_build_targets.png similarity index 100% rename from contributing/development/configuring_an_ide/img/code_blocks_build_targets.png rename to engine_details/development/configuring_an_ide/img/code_blocks_build_targets.png diff --git a/contributing/development/configuring_an_ide/img/code_blocks_compiler_and_configuration.png b/engine_details/development/configuring_an_ide/img/code_blocks_compiler_and_configuration.png similarity index 100% rename from contributing/development/configuring_an_ide/img/code_blocks_compiler_and_configuration.png rename to engine_details/development/configuring_an_ide/img/code_blocks_compiler_and_configuration.png diff --git a/contributing/development/configuring_an_ide/img/code_blocks_file_new_project.png b/engine_details/development/configuring_an_ide/img/code_blocks_file_new_project.png similarity index 100% rename from contributing/development/configuring_an_ide/img/code_blocks_file_new_project.png rename to engine_details/development/configuring_an_ide/img/code_blocks_file_new_project.png diff --git a/contributing/development/configuring_an_ide/img/code_blocks_new_empty_project.png b/engine_details/development/configuring_an_ide/img/code_blocks_new_empty_project.png similarity index 100% rename from contributing/development/configuring_an_ide/img/code_blocks_new_empty_project.png rename to engine_details/development/configuring_an_ide/img/code_blocks_new_empty_project.png diff --git a/contributing/development/configuring_an_ide/img/code_blocks_open_build_options.png b/engine_details/development/configuring_an_ide/img/code_blocks_open_build_options.png similarity index 100% rename from contributing/development/configuring_an_ide/img/code_blocks_open_build_options.png rename to engine_details/development/configuring_an_ide/img/code_blocks_open_build_options.png diff --git a/contributing/development/configuring_an_ide/img/code_blocks_open_properties.png b/engine_details/development/configuring_an_ide/img/code_blocks_open_properties.png similarity index 100% rename from contributing/development/configuring_an_ide/img/code_blocks_open_properties.png rename to engine_details/development/configuring_an_ide/img/code_blocks_open_properties.png diff --git a/contributing/development/configuring_an_ide/img/code_blocks_project_properties.png b/engine_details/development/configuring_an_ide/img/code_blocks_project_properties.png similarity index 100% rename from contributing/development/configuring_an_ide/img/code_blocks_project_properties.png rename to engine_details/development/configuring_an_ide/img/code_blocks_project_properties.png diff --git a/contributing/development/configuring_an_ide/img/code_blocks_project_title_and_location.png b/engine_details/development/configuring_an_ide/img/code_blocks_project_title_and_location.png similarity index 100% rename from contributing/development/configuring_an_ide/img/code_blocks_project_title_and_location.png rename to engine_details/development/configuring_an_ide/img/code_blocks_project_title_and_location.png diff --git a/contributing/development/configuring_an_ide/img/code_blocks_scons_clean.png b/engine_details/development/configuring_an_ide/img/code_blocks_scons_clean.png similarity index 100% rename from contributing/development/configuring_an_ide/img/code_blocks_scons_clean.png rename to engine_details/development/configuring_an_ide/img/code_blocks_scons_clean.png diff --git a/contributing/development/configuring_an_ide/img/code_blocks_scons_minimum.png b/engine_details/development/configuring_an_ide/img/code_blocks_scons_minimum.png similarity index 100% rename from contributing/development/configuring_an_ide/img/code_blocks_scons_minimum.png rename to engine_details/development/configuring_an_ide/img/code_blocks_scons_minimum.png diff --git a/contributing/development/configuring_an_ide/img/code_blocks_scons_windows.png b/engine_details/development/configuring_an_ide/img/code_blocks_scons_windows.png similarity index 100% rename from contributing/development/configuring_an_ide/img/code_blocks_scons_windows.png rename to engine_details/development/configuring_an_ide/img/code_blocks_scons_windows.png diff --git a/contributing/development/configuring_an_ide/img/code_blocks_select_files.png b/engine_details/development/configuring_an_ide/img/code_blocks_select_files.png similarity index 100% rename from contributing/development/configuring_an_ide/img/code_blocks_select_files.png rename to engine_details/development/configuring_an_ide/img/code_blocks_select_files.png diff --git a/contributing/development/configuring_an_ide/img/code_blocks_update_editor_settings.png b/engine_details/development/configuring_an_ide/img/code_blocks_update_editor_settings.png similarity index 100% rename from contributing/development/configuring_an_ide/img/code_blocks_update_editor_settings.png rename to engine_details/development/configuring_an_ide/img/code_blocks_update_editor_settings.png diff --git a/contributing/development/configuring_an_ide/img/code_blocks_wizard_welcome.png b/engine_details/development/configuring_an_ide/img/code_blocks_wizard_welcome.png similarity index 100% rename from contributing/development/configuring_an_ide/img/code_blocks_wizard_welcome.png rename to engine_details/development/configuring_an_ide/img/code_blocks_wizard_welcome.png diff --git a/engine_details/development/configuring_an_ide/img/kdevelop_addincludes.png b/engine_details/development/configuring_an_ide/img/kdevelop_addincludes.png new file mode 100644 index 000000000..e69de29bb diff --git a/engine_details/development/configuring_an_ide/img/kdevelop_addincludes.webp b/engine_details/development/configuring_an_ide/img/kdevelop_addincludes.webp new file mode 100644 index 000000000..e69de29bb diff --git a/engine_details/development/configuring_an_ide/img/kdevelop_buildconfig.png b/engine_details/development/configuring_an_ide/img/kdevelop_buildconfig.png new file mode 100644 index 000000000..e69de29bb diff --git a/engine_details/development/configuring_an_ide/img/kdevelop_buildconfig.webp b/engine_details/development/configuring_an_ide/img/kdevelop_buildconfig.webp new file mode 100644 index 000000000..e69de29bb diff --git a/engine_details/development/configuring_an_ide/img/kdevelop_configlaunches.png b/engine_details/development/configuring_an_ide/img/kdevelop_configlaunches.png new file mode 100644 index 000000000..e69de29bb diff --git a/engine_details/development/configuring_an_ide/img/kdevelop_configlaunches.webp b/engine_details/development/configuring_an_ide/img/kdevelop_configlaunches.webp new file mode 100644 index 000000000..e69de29bb diff --git a/engine_details/development/configuring_an_ide/img/kdevelop_configlaunches2.png b/engine_details/development/configuring_an_ide/img/kdevelop_configlaunches2.png new file mode 100644 index 000000000..e69de29bb diff --git a/engine_details/development/configuring_an_ide/img/kdevelop_configlaunches2.webp b/engine_details/development/configuring_an_ide/img/kdevelop_configlaunches2.webp new file mode 100644 index 000000000..e69de29bb diff --git a/engine_details/development/configuring_an_ide/img/kdevelop_custombuild.png b/engine_details/development/configuring_an_ide/img/kdevelop_custombuild.png new file mode 100644 index 000000000..e69de29bb diff --git a/engine_details/development/configuring_an_ide/img/kdevelop_custombuild.webp b/engine_details/development/configuring_an_ide/img/kdevelop_custombuild.webp new file mode 100644 index 000000000..e69de29bb diff --git a/engine_details/development/configuring_an_ide/img/kdevelop_newproject.png b/engine_details/development/configuring_an_ide/img/kdevelop_newproject.png new file mode 100644 index 000000000..e69de29bb diff --git a/engine_details/development/configuring_an_ide/img/kdevelop_newproject.webp b/engine_details/development/configuring_an_ide/img/kdevelop_newproject.webp new file mode 100644 index 000000000..e69de29bb diff --git a/engine_details/development/configuring_an_ide/img/kdevelop_openconfig.png b/engine_details/development/configuring_an_ide/img/kdevelop_openconfig.png new file mode 100644 index 000000000..e69de29bb diff --git a/engine_details/development/configuring_an_ide/img/kdevelop_openconfig.webp b/engine_details/development/configuring_an_ide/img/kdevelop_openconfig.webp new file mode 100644 index 000000000..e69de29bb diff --git a/contributing/development/configuring_an_ide/img/qtcreator-apply-import-filter.png b/engine_details/development/configuring_an_ide/img/qtcreator-apply-import-filter.png similarity index 100% rename from contributing/development/configuring_an_ide/img/qtcreator-apply-import-filter.png rename to engine_details/development/configuring_an_ide/img/qtcreator-apply-import-filter.png diff --git a/contributing/development/configuring_an_ide/img/qtcreator-edit-codestyle.png b/engine_details/development/configuring_an_ide/img/qtcreator-edit-codestyle.png similarity index 100% rename from contributing/development/configuring_an_ide/img/qtcreator-edit-codestyle.png rename to engine_details/development/configuring_an_ide/img/qtcreator-edit-codestyle.png diff --git a/contributing/development/configuring_an_ide/img/qtcreator-edit-files-menu.png b/engine_details/development/configuring_an_ide/img/qtcreator-edit-files-menu.png similarity index 100% rename from contributing/development/configuring_an_ide/img/qtcreator-edit-files-menu.png rename to engine_details/development/configuring_an_ide/img/qtcreator-edit-files-menu.png diff --git a/contributing/development/configuring_an_ide/img/qtcreator-new-project.png b/engine_details/development/configuring_an_ide/img/qtcreator-new-project.png similarity index 100% rename from contributing/development/configuring_an_ide/img/qtcreator-new-project.png rename to engine_details/development/configuring_an_ide/img/qtcreator-new-project.png diff --git a/contributing/development/configuring_an_ide/img/qtcreator-options-cpp.png b/engine_details/development/configuring_an_ide/img/qtcreator-options-cpp.png similarity index 100% rename from contributing/development/configuring_an_ide/img/qtcreator-options-cpp.png rename to engine_details/development/configuring_an_ide/img/qtcreator-options-cpp.png diff --git a/contributing/development/configuring_an_ide/img/qtcreator-project-name-includes.png b/engine_details/development/configuring_an_ide/img/qtcreator-project-name-includes.png similarity index 100% rename from contributing/development/configuring_an_ide/img/qtcreator-project-name-includes.png rename to engine_details/development/configuring_an_ide/img/qtcreator-project-name-includes.png diff --git a/contributing/development/configuring_an_ide/img/qtcreator-projects-build.png b/engine_details/development/configuring_an_ide/img/qtcreator-projects-build.png similarity index 100% rename from contributing/development/configuring_an_ide/img/qtcreator-projects-build.png rename to engine_details/development/configuring_an_ide/img/qtcreator-projects-build.png diff --git a/contributing/development/configuring_an_ide/img/qtcreator-run-command.png b/engine_details/development/configuring_an_ide/img/qtcreator-run-command.png similarity index 100% rename from contributing/development/configuring_an_ide/img/qtcreator-run-command.png rename to engine_details/development/configuring_an_ide/img/qtcreator-run-command.png diff --git a/contributing/development/configuring_an_ide/img/qtcreator-set-project-path.png b/engine_details/development/configuring_an_ide/img/qtcreator-set-project-path.png similarity index 100% rename from contributing/development/configuring_an_ide/img/qtcreator-set-project-path.png rename to engine_details/development/configuring_an_ide/img/qtcreator-set-project-path.png diff --git a/contributing/development/configuring_an_ide/img/qtcreator-set-scons-command.png b/engine_details/development/configuring_an_ide/img/qtcreator-set-scons-command.png similarity index 100% rename from contributing/development/configuring_an_ide/img/qtcreator-set-scons-command.png rename to engine_details/development/configuring_an_ide/img/qtcreator-set-scons-command.png diff --git a/contributing/development/configuring_an_ide/img/rider_attach_to_process.webp b/engine_details/development/configuring_an_ide/img/rider_attach_to_process.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/rider_attach_to_process.webp rename to engine_details/development/configuring_an_ide/img/rider_attach_to_process.webp diff --git a/contributing/development/configuring_an_ide/img/rider_attach_to_process_dialog.webp b/engine_details/development/configuring_an_ide/img/rider_attach_to_process_dialog.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/rider_attach_to_process_dialog.webp rename to engine_details/development/configuring_an_ide/img/rider_attach_to_process_dialog.webp diff --git a/contributing/development/configuring_an_ide/img/rider_configurations.webp b/engine_details/development/configuring_an_ide/img/rider_configurations.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/rider_configurations.webp rename to engine_details/development/configuring_an_ide/img/rider_configurations.webp diff --git a/contributing/development/configuring_an_ide/img/rider_configurations_changed.webp b/engine_details/development/configuring_an_ide/img/rider_configurations_changed.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/rider_configurations_changed.webp rename to engine_details/development/configuring_an_ide/img/rider_configurations_changed.webp diff --git a/contributing/development/configuring_an_ide/img/rider_run_debug.webp b/engine_details/development/configuring_an_ide/img/rider_run_debug.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/rider_run_debug.webp rename to engine_details/development/configuring_an_ide/img/rider_run_debug.webp diff --git a/contributing/development/configuring_an_ide/img/vs_1_install_cpp_package.png b/engine_details/development/configuring_an_ide/img/vs_1_install_cpp_package.png similarity index 100% rename from contributing/development/configuring_an_ide/img/vs_1_install_cpp_package.png rename to engine_details/development/configuring_an_ide/img/vs_1_install_cpp_package.png diff --git a/contributing/development/configuring_an_ide/img/vs_2_project_properties.png b/engine_details/development/configuring_an_ide/img/vs_2_project_properties.png similarity index 100% rename from contributing/development/configuring_an_ide/img/vs_2_project_properties.png rename to engine_details/development/configuring_an_ide/img/vs_2_project_properties.png diff --git a/contributing/development/configuring_an_ide/img/vs_3_debug_command_line.webp b/engine_details/development/configuring_an_ide/img/vs_3_debug_command_line.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/vs_3_debug_command_line.webp rename to engine_details/development/configuring_an_ide/img/vs_3_debug_command_line.webp diff --git a/contributing/development/configuring_an_ide/img/vs_4_debugging_main.png b/engine_details/development/configuring_an_ide/img/vs_4_debugging_main.png similarity index 100% rename from contributing/development/configuring_an_ide/img/vs_4_debugging_main.png rename to engine_details/development/configuring_an_ide/img/vs_4_debugging_main.png diff --git a/contributing/development/configuring_an_ide/img/vscode_1_create_launch.json.png b/engine_details/development/configuring_an_ide/img/vscode_1_create_launch.json.png similarity index 100% rename from contributing/development/configuring_an_ide/img/vscode_1_create_launch.json.png rename to engine_details/development/configuring_an_ide/img/vscode_1_create_launch.json.png diff --git a/contributing/development/configuring_an_ide/img/vscode_2_launch.json.png b/engine_details/development/configuring_an_ide/img/vscode_2_launch.json.png similarity index 100% rename from contributing/development/configuring_an_ide/img/vscode_2_launch.json.png rename to engine_details/development/configuring_an_ide/img/vscode_2_launch.json.png diff --git a/contributing/development/configuring_an_ide/img/vscode_3_tasks.json.png b/engine_details/development/configuring_an_ide/img/vscode_3_tasks.json.png similarity index 100% rename from contributing/development/configuring_an_ide/img/vscode_3_tasks.json.png rename to engine_details/development/configuring_an_ide/img/vscode_3_tasks.json.png diff --git a/contributing/development/configuring_an_ide/img/vscode_configure_task.png b/engine_details/development/configuring_an_ide/img/vscode_configure_task.png similarity index 100% rename from contributing/development/configuring_an_ide/img/vscode_configure_task.png rename to engine_details/development/configuring_an_ide/img/vscode_configure_task.png diff --git a/contributing/development/configuring_an_ide/img/vscode_create_tasksjson.png b/engine_details/development/configuring_an_ide/img/vscode_create_tasksjson.png similarity index 100% rename from contributing/development/configuring_an_ide/img/vscode_create_tasksjson.png rename to engine_details/development/configuring_an_ide/img/vscode_create_tasksjson.png diff --git a/contributing/development/configuring_an_ide/img/vscode_create_tasksjson_others.png b/engine_details/development/configuring_an_ide/img/vscode_create_tasksjson_others.png similarity index 100% rename from contributing/development/configuring_an_ide/img/vscode_create_tasksjson_others.png rename to engine_details/development/configuring_an_ide/img/vscode_create_tasksjson_others.png diff --git a/contributing/development/configuring_an_ide/img/vscode_edit_configurations.webp b/engine_details/development/configuring_an_ide/img/vscode_edit_configurations.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/vscode_edit_configurations.webp rename to engine_details/development/configuring_an_ide/img/vscode_edit_configurations.webp diff --git a/contributing/development/configuring_an_ide/img/xcode_1_create_external_build_project.webp b/engine_details/development/configuring_an_ide/img/xcode_1_create_external_build_project.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/xcode_1_create_external_build_project.webp rename to engine_details/development/configuring_an_ide/img/xcode_1_create_external_build_project.webp diff --git a/contributing/development/configuring_an_ide/img/xcode_2_set_external_build_project_parameters.webp b/engine_details/development/configuring_an_ide/img/xcode_2_set_external_build_project_parameters.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/xcode_2_set_external_build_project_parameters.webp rename to engine_details/development/configuring_an_ide/img/xcode_2_set_external_build_project_parameters.webp diff --git a/contributing/development/configuring_an_ide/img/xcode_3_configure_scons.webp b/engine_details/development/configuring_an_ide/img/xcode_3_configure_scons.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/xcode_3_configure_scons.webp rename to engine_details/development/configuring_an_ide/img/xcode_3_configure_scons.webp diff --git a/contributing/development/configuring_an_ide/img/xcode_4_add_new_target.webp b/engine_details/development/configuring_an_ide/img/xcode_4_add_new_target.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/xcode_4_add_new_target.webp rename to engine_details/development/configuring_an_ide/img/xcode_4_add_new_target.webp diff --git a/contributing/development/configuring_an_ide/img/xcode_5_select_command_line_target.webp b/engine_details/development/configuring_an_ide/img/xcode_5_select_command_line_target.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/xcode_5_select_command_line_target.webp rename to engine_details/development/configuring_an_ide/img/xcode_5_select_command_line_target.webp diff --git a/contributing/development/configuring_an_ide/img/xcode_6_after_add_godot_source_to_project.webp b/engine_details/development/configuring_an_ide/img/xcode_6_after_add_godot_source_to_project.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/xcode_6_after_add_godot_source_to_project.webp rename to engine_details/development/configuring_an_ide/img/xcode_6_after_add_godot_source_to_project.webp diff --git a/contributing/development/configuring_an_ide/img/xcode_7_setup_build_post_action.webp b/engine_details/development/configuring_an_ide/img/xcode_7_setup_build_post_action.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/xcode_7_setup_build_post_action.webp rename to engine_details/development/configuring_an_ide/img/xcode_7_setup_build_post_action.webp diff --git a/contributing/development/configuring_an_ide/img/xcode_8_setup_run_scheme.webp b/engine_details/development/configuring_an_ide/img/xcode_8_setup_run_scheme.webp similarity index 100% rename from contributing/development/configuring_an_ide/img/xcode_8_setup_run_scheme.webp rename to engine_details/development/configuring_an_ide/img/xcode_8_setup_run_scheme.webp diff --git a/contributing/development/configuring_an_ide/index.rst b/engine_details/development/configuring_an_ide/index.rst similarity index 100% rename from contributing/development/configuring_an_ide/index.rst rename to engine_details/development/configuring_an_ide/index.rst diff --git a/contributing/development/configuring_an_ide/kdevelop.rst b/engine_details/development/configuring_an_ide/kdevelop.rst similarity index 100% rename from contributing/development/configuring_an_ide/kdevelop.rst rename to engine_details/development/configuring_an_ide/kdevelop.rst diff --git a/contributing/development/configuring_an_ide/qt_creator.rst b/engine_details/development/configuring_an_ide/qt_creator.rst similarity index 96% rename from contributing/development/configuring_an_ide/qt_creator.rst rename to engine_details/development/configuring_an_ide/qt_creator.rst index 9bc2d02f5..c55770744 100644 --- a/contributing/development/configuring_an_ide/qt_creator.rst +++ b/engine_details/development/configuring_an_ide/qt_creator.rst @@ -91,7 +91,7 @@ To learn more about command line arguments, refer to the Code style configuration ------------------------ -Developers must follow the project's :ref:`code style ` +Developers must follow the project's `code style `__ and the IDE should help them follow it. By default, Qt Creator uses spaces for indentation which doesn't match the Godot code style guidelines. You can change this behavior by changing the **Code Style** in **Tools > Options > C++**. diff --git a/contributing/development/configuring_an_ide/rider.rst b/engine_details/development/configuring_an_ide/rider.rst similarity index 100% rename from contributing/development/configuring_an_ide/rider.rst rename to engine_details/development/configuring_an_ide/rider.rst diff --git a/contributing/development/configuring_an_ide/visual_studio.rst b/engine_details/development/configuring_an_ide/visual_studio.rst similarity index 100% rename from contributing/development/configuring_an_ide/visual_studio.rst rename to engine_details/development/configuring_an_ide/visual_studio.rst diff --git a/contributing/development/configuring_an_ide/visual_studio_code.rst b/engine_details/development/configuring_an_ide/visual_studio_code.rst similarity index 100% rename from contributing/development/configuring_an_ide/visual_studio_code.rst rename to engine_details/development/configuring_an_ide/visual_studio_code.rst diff --git a/contributing/development/configuring_an_ide/xcode.rst b/engine_details/development/configuring_an_ide/xcode.rst similarity index 100% rename from contributing/development/configuring_an_ide/xcode.rst rename to engine_details/development/configuring_an_ide/xcode.rst diff --git a/contributing/development/debugging/img/cpp_profiler_hotspot_flame_graph.png b/engine_details/development/debugging/img/cpp_profiler_hotspot_flame_graph.png similarity index 100% rename from contributing/development/debugging/img/cpp_profiler_hotspot_flame_graph.png rename to engine_details/development/debugging/img/cpp_profiler_hotspot_flame_graph.png diff --git a/contributing/development/debugging/img/cpp_profiler_hotspot_record.png b/engine_details/development/debugging/img/cpp_profiler_hotspot_record.png similarity index 100% rename from contributing/development/debugging/img/cpp_profiler_hotspot_record.png rename to engine_details/development/debugging/img/cpp_profiler_hotspot_record.png diff --git a/contributing/development/debugging/img/cpp_profiler_hotspot_view_results.png b/engine_details/development/debugging/img/cpp_profiler_hotspot_view_results.png similarity index 100% rename from contributing/development/debugging/img/cpp_profiler_hotspot_view_results.png rename to engine_details/development/debugging/img/cpp_profiler_hotspot_view_results.png diff --git a/contributing/development/debugging/img/cpp_profiler_hotspot_welcome.png b/engine_details/development/debugging/img/cpp_profiler_hotspot_welcome.png similarity index 100% rename from contributing/development/debugging/img/cpp_profiler_hotspot_welcome.png rename to engine_details/development/debugging/img/cpp_profiler_hotspot_welcome.png diff --git a/contributing/development/debugging/img/cpp_profiler_time_profiler.png b/engine_details/development/debugging/img/cpp_profiler_time_profiler.png similarity index 100% rename from contributing/development/debugging/img/cpp_profiler_time_profiler.png rename to engine_details/development/debugging/img/cpp_profiler_time_profiler.png diff --git a/contributing/development/debugging/img/cpp_profiler_time_profiler_record.png b/engine_details/development/debugging/img/cpp_profiler_time_profiler_record.png similarity index 100% rename from contributing/development/debugging/img/cpp_profiler_time_profiler_record.png rename to engine_details/development/debugging/img/cpp_profiler_time_profiler_record.png diff --git a/contributing/development/debugging/img/cpp_profiler_time_profiler_result.png b/engine_details/development/debugging/img/cpp_profiler_time_profiler_result.png similarity index 100% rename from contributing/development/debugging/img/cpp_profiler_time_profiler_result.png rename to engine_details/development/debugging/img/cpp_profiler_time_profiler_result.png diff --git a/contributing/development/debugging/img/cpp_profiler_verysleepy_results_filtered.png b/engine_details/development/debugging/img/cpp_profiler_verysleepy_results_filtered.png similarity index 100% rename from contributing/development/debugging/img/cpp_profiler_verysleepy_results_filtered.png rename to engine_details/development/debugging/img/cpp_profiler_verysleepy_results_filtered.png diff --git a/contributing/development/debugging/img/cpp_profiler_verysleepy_select_process.png b/engine_details/development/debugging/img/cpp_profiler_verysleepy_select_process.png similarity index 100% rename from contributing/development/debugging/img/cpp_profiler_verysleepy_select_process.png rename to engine_details/development/debugging/img/cpp_profiler_verysleepy_select_process.png diff --git a/contributing/development/debugging/img/cpp_profiler_xcode_menu.png b/engine_details/development/debugging/img/cpp_profiler_xcode_menu.png similarity index 100% rename from contributing/development/debugging/img/cpp_profiler_xcode_menu.png rename to engine_details/development/debugging/img/cpp_profiler_xcode_menu.png diff --git a/contributing/development/debugging/index.rst b/engine_details/development/debugging/index.rst similarity index 100% rename from contributing/development/debugging/index.rst rename to engine_details/development/debugging/index.rst diff --git a/contributing/development/debugging/macos_debug.rst b/engine_details/development/debugging/macos_debug.rst similarity index 100% rename from contributing/development/debugging/macos_debug.rst rename to engine_details/development/debugging/macos_debug.rst diff --git a/contributing/development/debugging/using_cpp_profilers.rst b/engine_details/development/debugging/using_cpp_profilers.rst similarity index 100% rename from contributing/development/debugging/using_cpp_profilers.rst rename to engine_details/development/debugging/using_cpp_profilers.rst diff --git a/contributing/development/debugging/using_sanitizers.rst b/engine_details/development/debugging/using_sanitizers.rst similarity index 100% rename from contributing/development/debugging/using_sanitizers.rst rename to engine_details/development/debugging/using_sanitizers.rst diff --git a/contributing/development/debugging/vulkan/index.rst b/engine_details/development/debugging/vulkan/index.rst similarity index 100% rename from contributing/development/debugging/vulkan/index.rst rename to engine_details/development/debugging/vulkan/index.rst diff --git a/contributing/development/debugging/vulkan/vulkan_validation_layers.rst b/engine_details/development/debugging/vulkan/vulkan_validation_layers.rst similarity index 100% rename from contributing/development/debugging/vulkan/vulkan_validation_layers.rst rename to engine_details/development/debugging/vulkan/vulkan_validation_layers.rst diff --git a/contributing/development/handling_compatibility_breakages.rst b/engine_details/development/handling_compatibility_breakages.rst similarity index 100% rename from contributing/development/handling_compatibility_breakages.rst rename to engine_details/development/handling_compatibility_breakages.rst diff --git a/engine_details/development/index.rst b/engine_details/development/index.rst new file mode 100644 index 000000000..3acfc62ee --- /dev/null +++ b/engine_details/development/index.rst @@ -0,0 +1,19 @@ +:allow_comments: False + +.. _doc_contributing_to_the_engine: + +Engine development +================== + +The guides below explain how to work on the engine's codebase. +If you plan to contribute to the engine, please make sure to also read the +`contribution guidelines `__. + +.. toctree:: + :maxdepth: 1 + :name: toc-contributing-to-the-engine-environment + + configuring_an_ide/index + compiling/index + debugging/index + handling_compatibility_breakages diff --git a/contributing/development/editor/creating_icons.rst b/engine_details/editor/creating_icons.rst similarity index 95% rename from contributing/development/editor/creating_icons.rst rename to engine_details/editor/creating_icons.rst index 374db2f4b..2006fac3b 100644 --- a/contributing/development/editor/creating_icons.rst +++ b/engine_details/editor/creating_icons.rst @@ -53,7 +53,7 @@ Icon optimization Because the editor renders SVGs once at load time, they need to be small in size so they can be efficiently parsed. When the -:ref:`pre-commit hook ` runs, it automatically optimizes +`pre-commit hook `__ runs, it automatically optimizes the SVG using `svgo `_. .. note:: @@ -91,4 +91,4 @@ If icons don't appear in the editor, make sure that: References ~~~~~~~~~~ -- `editor/icons `__ +- `editor/icons `__ \ No newline at end of file diff --git a/engine_details/editor/index.rst b/engine_details/editor/index.rst new file mode 100644 index 000000000..5051e37a9 --- /dev/null +++ b/engine_details/editor/index.rst @@ -0,0 +1,15 @@ +:allow_comments: False + +Editor development +================== + +This section documents how to work with the source code of the Godot editor. +When contributing to the Godot engine, you should also read the +`editor style guide `__. + +.. toctree:: + :maxdepth: 1 + :name: toc-devel-editor + + introduction_to_editor_development + creating_icons diff --git a/contributing/development/editor/introduction_to_editor_development.rst b/engine_details/editor/introduction_to_editor_development.rst similarity index 99% rename from contributing/development/editor/introduction_to_editor_development.rst rename to engine_details/editor/introduction_to_editor_development.rst index f5d23b084..031f32334 100644 --- a/contributing/development/editor/introduction_to_editor_development.rst +++ b/engine_details/editor/introduction_to_editor_development.rst @@ -85,4 +85,4 @@ Development tips To iterate quickly on the editor, we recommend to set up a test project and :ref:`open it from the command line ` after compiling the editor. This way, you don't have to go through the Project Manager every -time you start Godot. +time you start Godot. \ No newline at end of file diff --git a/contributing/development/file_formats/gdscript_grammar.rst b/engine_details/file_formats/gdscript_grammar.rst similarity index 100% rename from contributing/development/file_formats/gdscript_grammar.rst rename to engine_details/file_formats/gdscript_grammar.rst diff --git a/contributing/development/file_formats/index.rst b/engine_details/file_formats/index.rst similarity index 100% rename from contributing/development/file_formats/index.rst rename to engine_details/file_formats/index.rst diff --git a/contributing/development/file_formats/tscn.rst b/engine_details/file_formats/tscn.rst similarity index 100% rename from contributing/development/file_formats/tscn.rst rename to engine_details/file_formats/tscn.rst diff --git a/index.rst b/index.rst index 1615a93af..b02193ff2 100644 --- a/index.rst +++ b/index.rst @@ -128,13 +128,14 @@ the ``GodotEngine.epub`` file in an e-book reader application. .. toctree:: :hidden: :maxdepth: 1 - :caption: Contributing - :name: sec-contributing + :caption: Engine details + :name: sec-engine-details - contributing/how_to_contribute - contributing/workflow/index - contributing/development/index - contributing/documentation/index + engine_details/architecture/index + engine_details/development/index + engine_details/editor/index + engine_details/class_reference/index + engine_details/file_formats/index .. toctree::