From 6a6080e867c64bd59dc2bfdb5d9c267dfcdcfefa Mon Sep 17 00:00:00 2001 From: Arjan Dikhoff Date: Sat, 26 Oct 2024 19:55:47 +0200 Subject: [PATCH] Remove refs to 3.6 Removed links and other refs to 3.6. Also removed some paragraphs and parts of tables that don't make sense to be in Redot docs. --- .github/workflows/build_offline_docs.yml | 1 - README.md | 6 +- _templates/versions.html | 14 - about/docs_changelog.rst | 401 ----------------------- about/release_policy.rst | 54 +-- index.rst | 4 +- migrate.py | 4 +- 7 files changed, 10 insertions(+), 474 deletions(-) diff --git a/.github/workflows/build_offline_docs.yml b/.github/workflows/build_offline_docs.yml index 6fff01ce2b6..fc74d9829bd 100644 --- a/.github/workflows/build_offline_docs.yml +++ b/.github/workflows/build_offline_docs.yml @@ -14,7 +14,6 @@ jobs: branch: - master - stable - - 3.6 steps: - uses: actions/checkout@v4 with: diff --git a/README.md b/README.md index 410f634ba87..36efcc75802 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,12 @@ They are meant to be parsed with the [Sphinx](https://www.sphinx-doc.org/) docum To browse the documentation offline, you can download an HTML copy (updated every Monday): [stable](https://download.redotengine.org/docs/redot-docs-html-stable.zip), -[latest](https://download.redotengine.org/docs/redot-docs-html-master.zip), -[3.6](https://download.redotengine.org/docs/redot-docs-html-3.6.zip). Extract +[latest](https://download.redotengine.org/docs/redot-docs-html-master.zip). Extract the ZIP archive then open the top-level `index.html` in a web browser. For mobile devices or e-readers, you can also download an ePub copy (updated every Monday): [stable](https://download.redotengine.org/docs/redot-docs-epub-stable.zip), -[latest](https://download.redotengine.org/docs/redot-docs-epub-master.zip), -[3.6](https://download.redotengine.org/docs/redot-docs-epub-3.6.zip). Extract +[latest](https://download.redotengine.org/docs/redot-docs-epub-master.zip). Extract the ZIP archive then open the `RedotEngine.epub` file in an e-book reader application. ## Theming diff --git a/_templates/versions.html b/_templates/versions.html index e46ca819a95..7adccecf2a0 100644 --- a/_templates/versions.html +++ b/_templates/versions.html @@ -34,24 +34,10 @@
{{ slug }}
{% endfor %} -
- {# Translators: The phrase "Read the Docs" is not translated #} -
{{ _('On Read the Docs') }}
-
- {{ _('Project Home') }} -
-
- {{ _('Builds') }} -
-
- {{ _('Downloads') }} -
-
Hosted by Read the Docs - ยท Privacy Policy diff --git a/about/docs_changelog.rst b/about/docs_changelog.rst index 6c432a56ab4..61b7f2b610c 100644 --- a/about/docs_changelog.rst +++ b/about/docs_changelog.rst @@ -59,404 +59,3 @@ Physics ^^^^^^^ - :ref:`doc_troubleshooting_physics_issues` - -New pages since version 3.6 ---------------------------- - -2D -^^ - -- :ref:`doc_2d_antialiasing` - -3D -^^ - -- :ref:`doc_3d_antialiasing` -- :ref:`doc_faking_global_illumination` -- :ref:`doc_introduction_to_global_illumination` -- :ref:`doc_mesh_lod` -- :ref:`doc_occlusion_culling` -- :ref:`doc_using_sdfgi` -- :ref:`doc_using_decals` -- :ref:`doc_visibility_ranges` -- :ref:`doc_volumetric_fog` -- :ref:`doc_variable_rate_shading` -- :ref:`doc_physical_light_and_camera_units` - -Animation -^^^^^^^^^ - -- :ref:`doc_creating_movies` - -Assets pipeline -^^^^^^^^^^^^^^^ - -- :ref:`doc_retargeting_3d_skeletons` - -Development -^^^^^^^^^^^ - -- :ref:`doc_custom_platform_ports` - -Migrating -^^^^^^^^^ - -- :ref:`doc_upgrading_to_godot_4` - -Physics -^^^^^^^ - -- :ref:`doc_large_world_coordinates` - -Scripting -^^^^^^^^^ - -- :ref:`doc_custom_performance_monitors` -- :ref:`doc_c_sharp_collections` -- :ref:`doc_c_sharp_global_classes` -- :ref:`doc_c_sharp_variant` - -Shaders -^^^^^^^ - -- :ref:`doc_compute_shaders` - -Workflow -^^^^^^^^ - -- :ref:`doc_pr_review_guidelines` - -XR -^^ - -- :ref:`doc_introducing_xr_tools` -- :ref:`doc_xr_action_map` -- :ref:`doc_deploying_to_android` - -New pages since version 3.5 ---------------------------- - -None. - -New pages since version 3.4 ---------------------------- - -3D -^^ - -- :ref:`doc_3d_text` - -Animation -^^^^^^^^^ - -- :ref:`doc_playing_videos` - -Editor -^^^^^^ - -- :ref:`doc_managing_editor_features` - -New pages since version 3.3 ---------------------------- - -C++ -^^^ - -- :ref:`doc_cpp_usage_guidelines` - -GDScript -^^^^^^^^ - -- :ref:`doc_gdscript_documentation_comments` - -New pages since version 3.2 ---------------------------- - -3D -^^ - -- :ref:`doc_3d_rendering_limitations` - -About -^^^^^ - -- :ref:`doc_troubleshooting` -- :ref:`doc_list_of_features` -- :ref:`doc_release_policy` - -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_vulkan_validation_layers` -- :ref:`doc_gdscript_grammar` -- Configuring an IDE: :ref:`doc_configuring_an_ide_code_blocks` - -Editor -^^^^^^ - -- :ref:`doc_default_key_mapping` -- :ref:`doc_using_the_web_editor` - -Export -^^^^^^ - -- :ref:`doc_exporting_for_dedicated_servers` - -Input -^^^^^ - -- :ref:`doc_controllers_gamepads_joysticks` - -Math -^^^^ - -- :ref:`doc_random_number_generation` - -Platform-specific -^^^^^^^^^^^^^^^^^ - -- :ref:`doc_plugins_for_ios` -- :ref:`doc_ios_plugin` -- :ref:`doc_html5_shell_classref` - -Physics -^^^^^^^ - -- :ref:`doc_collision_shapes_2d` -- :ref:`doc_collision_shapes_3d` - -Shaders -^^^^^^^ - -- :ref:`doc_shaders_style_guide` - -Scripting -^^^^^^^^^ - -- :ref:`doc_debugger_panel` -- :ref:`doc_creating_script_templates` -- :ref:`doc_evaluating_expressions` -- :ref:`doc_what_is_gdextension` -- :ref:`doc_gdscript_warning_system` (split from :ref:`doc_gdscript_static_typing`) - -User Interface (UI) -^^^^^^^^^^^^^^^^^^^ - -- :ref:`doc_control_node_gallery` - -New pages since version 3.1 ---------------------------- - -Project workflow -^^^^^^^^^^^^^^^^ - -- :ref:`doc_android_gradle_build` - -2D -^^ - -- :ref:`doc_2d_sprite_animation` - -Audio -^^^^^ - -- :ref:`doc_recording_with_microphone` -- :ref:`doc_sync_with_audio` - -Math -^^^^ - -- :ref:`doc_beziers_and_curves` -- :ref:`doc_interpolation` - -Inputs -^^^^^^ - -- :ref:`doc_input_examples` - -Internationalization -^^^^^^^^^^^^^^^^^^^^ - -- :ref:`doc_localization_using_gettext` - -Shading -^^^^^^^ - -- Your First Shader Series: - - :ref:`doc_introduction_to_shaders` - - :ref:`doc_your_first_canvasitem_shader` - - :ref:`doc_your_first_spatial_shader` - - :ref:`doc_your_second_spatial_shader` -- :ref:`doc_visual_shaders` - -Networking -^^^^^^^^^^ - -- :ref:`doc_webrtc` - -Plugins -^^^^^^^ - -- :ref:`doc_android_plugin` -- :ref:`doc_inspector_plugins` -- :ref:`doc_visual_shader_plugins` - -Multi-threading -^^^^^^^^^^^^^^^ - -- :ref:`doc_using_multiple_threads` - -Creating content -^^^^^^^^^^^^^^^^ - -Procedural geometry series: - - :ref:`Procedural geometry ` - - :ref:`doc_arraymesh` - - :ref:`doc_surfacetool` - - :ref:`doc_meshdatatool` - - :ref:`doc_immediatemesh` - -Optimization -^^^^^^^^^^^^ - -- :ref:`doc_using_multimesh` -- :ref:`doc_using_servers` - -Legal -^^^^^ - -- :ref:`doc_complying_with_licenses` - -New pages since version 3.0 ---------------------------- - -Step by step -^^^^^^^^^^^^ - -- :ref:`doc_signals` -- Exporting - -Scripting -^^^^^^^^^ - -- :ref:`doc_gdscript_static_typing` - -Project workflow -^^^^^^^^^^^^^^^^ - -Best Practices: - -- :ref:`doc_introduction_best_practices` -- :ref:`doc_what_are_godot_classes` -- :ref:`doc_scene_organization` -- :ref:`doc_scenes_versus_scripts` -- :ref:`doc_autoloads_versus_internal_nodes` -- :ref:`doc_node_alternatives` -- :ref:`doc_godot_interfaces` -- :ref:`doc_godot_notifications` -- :ref:`doc_data_preferences` -- :ref:`doc_logic_preferences` - -2D -^^ - -- :ref:`doc_2d_lights_and_shadows` -- :ref:`doc_2d_meshes` - -3D -^^ - -- :ref:`doc_csg_tools` -- :ref:`doc_animating_thousands_of_fish` -- :ref:`doc_controlling_thousands_of_fish` - -Physics -^^^^^^^ - -- :ref:`doc_ragdoll_system` -- :ref:`doc_soft_body` - -Animation -^^^^^^^^^ - -- :ref:`doc_2d_skeletons` -- :ref:`doc_animation_tree` - -GUI -^^^ - -- :ref:`doc_gui_containers` - -Viewports -^^^^^^^^^ - -- :ref:`doc_viewport_as_texture` -- :ref:`doc_custom_postprocessing` - -Shading -^^^^^^^ - -- :ref:`doc_converting_glsl_to_godot_shaders` -- :ref:`doc_advanced_postprocessing` - -Shading Reference: - -- :ref:`doc_introduction_to_shaders` -- :ref:`doc_shading_language` -- :ref:`doc_spatial_shader` -- :ref:`doc_canvas_item_shader` -- :ref:`doc_particle_shader` - -Plugins -^^^^^^^ - -- :ref:`doc_making_main_screen_plugins` -- :ref:`doc_3d_gizmo_plugins` - -Platform-specific -^^^^^^^^^^^^^^^^^ - -- :ref:`doc_customizing_html5_shell` - -Multi-threading -^^^^^^^^^^^^^^^ - -- :ref:`doc_thread_safe_apis` - -Creating content -^^^^^^^^^^^^^^^^ - -- :ref:`doc_making_trees` - -Miscellaneous -^^^^^^^^^^^^^ - -- :ref:`doc_jitter_stutter` -- :ref:`doc_running_code_in_the_editor` -- :ref:`doc_change_scenes_manually` - -Compiling -^^^^^^^^^ - -- :ref:`doc_optimizing_for_size` -- :ref:`doc_compiling_with_script_encryption_key` - -Engine development -^^^^^^^^^^^^^^^^^^ - -- :ref:`doc_binding_to_external_libraries` diff --git a/about/release_policy.rst b/about/release_policy.rst index 734a34b4381..28daf353cf0 100644 --- a/about/release_policy.rst +++ b/about/release_policy.rst @@ -71,8 +71,7 @@ who need maintenance updates. Whenever a new major version is released, we make the previous stable branch a long-term supported release, and do our best to provide fixes for issues encountered by users of that branch who cannot port complex projects to the new -major version. This was the case for the 2.1 branch, and is the case for the -3.6 branch. +major version. In a given minor release series, only the latest patch release receives support. If you experience an issue using an older patch release, please upgrade to the @@ -82,41 +81,12 @@ on GitHub. +--------------+----------------------+--------------------------------------------------------------------------+ | **Version** | **Release date** | **Support level** | +--------------+----------------------+--------------------------------------------------------------------------+ -| Godot 4.3 | June 2024 | |unstable| *Development.* Receives new features, usability and | -| (`master`) | (estimate) | performance improvements, as well as bug fixes, while under development. | +| Godot 4.4 | Q1 2025 (estimate) | |unstable| *Development.* Receives new features, usability and | +| (`master`) | | performance improvements, as well as bug fixes, while under development. | +--------------+----------------------+--------------------------------------------------------------------------+ -| Godot 4.2 | November 2023 | |supported| Receives fixes for bugs and security issues, as well as | +| Godot 4.3 | August 2024 | |supported| Receives fixes for bugs and security issues, as well as | | | | patches that enable platform support. | +--------------+----------------------+--------------------------------------------------------------------------+ -| Godot 4.1 | July 2023 | |supported| Receives fixes for bugs and security issues, as well as | -| | | patches that enable platform support. | -+--------------+----------------------+--------------------------------------------------------------------------+ -| Godot 4.0 | March 2023 | |eol| No longer supported (last update: 4.0.4). | -+--------------+----------------------+--------------------------------------------------------------------------+ -| Godot 3.6 | Q1 2024 (estimate) | |supported| *Beta.* Receives new features, usability and performance | -| (`3.x`, LTS) | | improvements, as well as bug fixes, while under development. | -+--------------+----------------------+--------------------------------------------------------------------------+ -| Godot 3.5 | August 2022 | |supported| Receives fixes for bugs and security issues, as well as | -| | | patches that enable platform support. | -+--------------+----------------------+--------------------------------------------------------------------------+ -| Godot 3.4 | November 2021 | |eol| No longer supported (last update: 3.4.5). | -+--------------+----------------------+--------------------------------------------------------------------------+ -| Godot 3.3 | April 2021 | |eol| No longer supported (last update: 3.3.4). | -+--------------+----------------------+--------------------------------------------------------------------------+ -| Godot 3.2 | January 2020 | |eol| No longer supported (last update: 3.2.3). | -+--------------+----------------------+--------------------------------------------------------------------------+ -| Godot 3.1 | March 2019 | |eol| No longer supported (last update: 3.1.2). | -+--------------+----------------------+--------------------------------------------------------------------------+ -| Godot 3.0 | January 2018 | |eol| No longer supported (last update: 3.0.6). | -+--------------+----------------------+--------------------------------------------------------------------------+ -| Godot 2.1 | July 2016 | |eol| No longer supported (last update: 2.1.6). | -+--------------+----------------------+--------------------------------------------------------------------------+ -| Godot 2.0 | February 2016 | |eol| No longer supported (last update: 2.0.4.1). | -+--------------+----------------------+--------------------------------------------------------------------------+ -| Godot 1.1 | May 2015 | |eol| No longer supported. | -+--------------+----------------------+--------------------------------------------------------------------------+ -| Godot 1.0 | December 2014 | |eol| No longer supported. | -+--------------+----------------------+--------------------------------------------------------------------------+ .. |supported| image:: img/supported.png .. |partial| image:: img/partial.png @@ -132,11 +102,6 @@ on GitHub. Pre-release Godot versions aren't intended to be used in production and are provided for testing purposes only. -.. seealso:: - - See :ref:`doc_upgrading_to_godot_4` for instructions on migrating a project - from Godot 3.x to 4.x. - .. _doc_release_policy_which_version_should_i_use: Which version should I use for a new project? @@ -186,10 +151,7 @@ the documentation. previously existing functionality and may raise hardware requirements. They also require much more work to upgrade to compared to minor releases. As a result, we recommend sticking with the major release you've started your project with if -you are happy with how your project currently works. For example, if your -project was started with 3.5, we recommend upgrading to 3.5.2 and possibly 3.6 -in the future, but not to 4.0+, unless your project really needs the new -features that come with 4.0+. +you are happy with how your project currently works. .. _doc_release_policy_when_is_next_release_out: @@ -212,12 +174,6 @@ Maintenance (patch) releases are released as needed with potentially very short development cycles, to provide users of the current stable branch with the latest bug fixes for their production needs. -The 3.6 release is still planned and should be the last stable branch of Godot -3.x. It will be a Long-Term Support (LTS) release, which we plan to support for -as long as users still need it (due to missing features in Godot 4.x, or -having published games which they need to keep updating for platform -requirements). - What are the criteria for compatibility across engine versions? --------------------------------------------------------------- diff --git a/index.rst b/index.rst index 78d1157ac51..f890a2c79c4 100644 --- a/index.rst +++ b/index.rst @@ -27,10 +27,10 @@ Submit an issue or pull request on the `GitHub repository `__, `latest `__, `3.6 `__. Extract the ZIP archive then open +To browse the documentation offline, you can download an HTML copy (updated every Monday): `stable `__, `latest `__. Extract the ZIP archive then open the top-level ``index.html`` in a web browser. -For mobile devices or e-readers, you can also download an ePub copy (updated every Monday): `stable `__, `latest `__, `3.6 `__. Extract the ZIP archive then open +For mobile devices or e-readers, you can also download an ePub copy (updated every Monday): `stable `__, `latest `__. Extract the ZIP archive then open the ``GodotEngine.epub`` file in an e-book reader application. .. Below is the main table-of-content tree of the documentation website. diff --git a/migrate.py b/migrate.py index 4eacc02c164..3e4e9ff7e13 100644 --- a/migrate.py +++ b/migrate.py @@ -134,10 +134,8 @@ # These will have to change eventually. ('https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-html-stable.zip', 'https://download.redotengine.org/docs/redot-docs-html-stable.zip'), ('https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-html-master.zip', 'https://download.redotengine.org/docs/redot-docs-html-master.zip'), - ('https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-html-3.6.zip', 'https://download.redotengine.org/docs/redot-docs-html-3.6.zip'), ('https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-epub-stable.zip', 'https://download.redotengine.org/docs/redot-docs-epub-stable.zip'), ('https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-epub-master.zip', 'https://download.redotengine.org/docs/redot-docs-epub-master.zip'), - ('https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-epub-3.6.zip', 'https://download.redotengine.org/docs/redot-docs-epub-3.6.zip'), # Table breakers ('| ``"Please include this when reporting the bug on: https://github.com/godotengine/godot/issues"`` |', '| ``"Please include this when reporting the bug on: https://github.com/redot-engine/godot/issues"``|'), ('https://github.com/godotengine/godot/pull/40364>`_ for more. |', 'https://github.com/redot-engine/redot/pull/40364>`_ for more. |'), @@ -205,7 +203,7 @@ (' Read the Docs', ' Versions'), ("const homeUrl = baseUrl.split('/latest/')[0] + '/stable/';", "const homeUrl = '/en/stable';"), ('{% set listed_languages = ({"en":"#", "de":"#", "es":"#", "fr":"#"}).items() -%}', '{% set listed_languages = ({"en":"#"}).items() -%}'), - ('({"stable":"#", "latest":"#"})', '({"stable":"/en/stable", "latest":"/en/latest", "3.6":"/en/3.6"})'), + ('({"stable":"#", "latest":"#"})', '({"stable":"/en/stable", "latest":"/en/latest"})'), ('Hosted by Read the Docs', 'Hosted by CloudFlare'), ('Privacy Policy', ''), ('G-dot', 'Godot'),