Skip to content

Commit

Permalink
Add caution message that this is outdated documentation
Browse files Browse the repository at this point in the history
And further cleanup intro text which is outdated.
  • Loading branch information
akien-mga committed Feb 15, 2023
1 parent 1163569 commit ff0fffe
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 55 deletions.
15 changes: 0 additions & 15 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -263,18 +263,3 @@ def godot_get_image_filename_for_language(filename, env):
return path

sphinx.util.i18n.get_image_filename_for_language = godot_get_image_filename_for_language

# 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,
)
47 changes: 7 additions & 40 deletions index.rst
Original file line number Diff line number Diff line change
@@ -1,26 +1,15 @@
Godot Docs – *3.3* branch
=========================

.. only:: not i18n
.. caution::

.. note:: Godot's documentation is available in various languages and versions.
Expand the "Read the Docs" panel at the bottom of the sidebar to see
the list.
This is the documentation for Godot 3.3, released in 2021. This version
is no longer supported, but its documentation is still available for
reference.

.. only:: i18n

.. note:: This documentation is translated from the `original English one
<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.
Please refer to the `stable <https://docs.godotengine.org/en/stable>`_
and `latest <https://docs.godotengine.org/en/latest>`_ branches of the
documentation for up-to-date information.

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
Expand All @@ -32,28 +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
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 either the ``#documentation``
channel on `Discord <https://discord.gg/zH7NUgz>`_, or 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:

.. toctree::
Expand Down

0 comments on commit ff0fffe

Please sign in to comment.