mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 17:28:58 +00:00
Add caution message that this is outdated documentation
And further cleanup intro text which is outdated.
This commit is contained in:
@@ -273,18 +273,3 @@ if is_i18n and os.path.exists("../classes/" + language):
|
|||||||
shutil.rmtree("classes")
|
shutil.rmtree("classes")
|
||||||
|
|
||||||
os.symlink("../classes/" + language, "classes")
|
os.symlink("../classes/" + language, "classes")
|
||||||
|
|
||||||
# Couldn't find a way to retrieve variables nor do advanced string
|
|
||||||
# concat from reST, so had to hardcode this in the "epilog" added to
|
|
||||||
# all pages. This is used in index.rst to display the Weblate badge.
|
|
||||||
# On English pages, the badge points to the language-neutral engage page.
|
|
||||||
rst_epilog = """
|
|
||||||
.. |weblate_widget| image:: https://hosted.weblate.org/widgets/godot-engine/{image_locale}/godot-docs/287x66-white.png
|
|
||||||
:alt: Translation status
|
|
||||||
:target: https://hosted.weblate.org/engage/godot-engine{target_locale}/?utm_source=widget
|
|
||||||
:width: 287
|
|
||||||
:height: 66
|
|
||||||
""".format(
|
|
||||||
image_locale="-" if language == "en" else language,
|
|
||||||
target_locale="" if language == "en" else "/" + language,
|
|
||||||
)
|
|
||||||
|
|||||||
@@ -1,26 +1,15 @@
|
|||||||
Godot Docs – *3.4* branch
|
Godot Docs – *3.4* branch
|
||||||
=========================
|
=========================
|
||||||
|
|
||||||
.. only:: not i18n
|
.. caution::
|
||||||
|
|
||||||
.. note:: Godot's documentation is available in various languages and versions.
|
This is the documentation for Godot 3.4, released in 2021. This version
|
||||||
Expand the "Read the Docs" panel at the bottom of the sidebar to see
|
is no longer supported, but its documentation is still available for
|
||||||
the list.
|
reference.
|
||||||
|
|
||||||
.. only:: i18n
|
Please refer to the `stable <https://docs.godotengine.org/en/stable>`_
|
||||||
|
and `latest <https://docs.godotengine.org/en/latest>`_ branches of the
|
||||||
.. note:: This documentation is translated from the `original English one
|
documentation for up-to-date information.
|
||||||
<https://docs.godotengine.org/en/latest>`_ by community members
|
|
||||||
on `Weblate <https://hosted.weblate.org/projects/godot-engine/godot-docs>`_.
|
|
||||||
|
|
||||||
Depending on the translation effort's completion level, you may
|
|
||||||
find paragraphs or whole pages which are still in English. You can
|
|
||||||
help the community by providing new translations or reviewing existing
|
|
||||||
ones on Weblate.
|
|
||||||
|
|
||||||
For the time being, localized translations are only available for
|
|
||||||
the "latest" (development) branch, but should be suitable to learn
|
|
||||||
how to use stable Godot releases nevertheless.
|
|
||||||
|
|
||||||
Welcome to the official documentation of `Godot Engine <https://godotengine.org>`__,
|
Welcome to the official documentation of `Godot Engine <https://godotengine.org>`__,
|
||||||
the free and open source community-driven 2D and 3D game engine! If you are new
|
the free and open source community-driven 2D and 3D game engine! If you are new
|
||||||
@@ -32,27 +21,6 @@ The table of contents below and in the sidebar should let you easily access the
|
|||||||
documentation for your topic of interest. You can also use the search function
|
documentation for your topic of interest. You can also use the search function
|
||||||
in the top left corner.
|
in the top left corner.
|
||||||
|
|
||||||
You can also `download an HTML copy <https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-html-stable.zip>`__
|
|
||||||
for offline reading (updated every Monday). Extract the ZIP archive then open
|
|
||||||
the top-level ``index.html`` in a web browser.
|
|
||||||
|
|
||||||
.. note:: Godot Engine is an open source project developed by a community of
|
|
||||||
volunteers. The documentation team can always use your
|
|
||||||
feedback and help to improve the tutorials and class reference. If
|
|
||||||
you don't understand something, or cannot find what you
|
|
||||||
are looking for in the docs, help us make the documentation better
|
|
||||||
by letting us know!
|
|
||||||
|
|
||||||
Submit an issue or pull request on the `GitHub repository
|
|
||||||
<https://github.com/godotengine/godot-docs/issues>`_,
|
|
||||||
help us `translate the documentation
|
|
||||||
<https://hosted.weblate.org/engage/godot-engine/>`_ into your
|
|
||||||
language, or talk to us on the
|
|
||||||
``#documentation`` channel on the `Godot Contributors Chat
|
|
||||||
<https://chat.godotengine.org/>`_!
|
|
||||||
|
|
||||||
.. centered:: |weblate_widget|
|
|
||||||
|
|
||||||
The main documentation for the site is organized into the following sections:
|
The main documentation for the site is organized into the following sections:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
|||||||
Reference in New Issue
Block a user