mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
c03229cd9d
This also updates the index page, changes the first
sidebar section to be "About" without an extra level,
and renames "Tutorials" to "Manual"
(cherry picked from commit 0c100d9f14)
164 lines
5.1 KiB
ReStructuredText
164 lines
5.1 KiB
ReStructuredText
Godot Docs – *3.5* branch
|
||
=========================
|
||
|
||
.. only:: not i18n
|
||
|
||
.. 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.
|
||
|
||
.. only:: i18n
|
||
|
||
.. note:: This documentation is translated from the `original English one
|
||
<https://docs.godotengine.org/en/stable>`_ 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 "stable" branch. You can still view the English documentation for
|
||
other engine versions using the "Read the Docs" panel at the bottom
|
||
of the sidebar.
|
||
|
||
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
|
||
to this documentation, we recommend that you read the
|
||
:ref:`introduction page <doc_about_intro>` to get an overview of what this
|
||
documentation has to offer.
|
||
|
||
The table of contents 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.
|
||
|
||
Get involved
|
||
------------
|
||
|
||
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|
|
||
|
||
Offline documentation
|
||
---------------------
|
||
|
||
To browse the documentation offline, you can use the mirror of the documentation
|
||
hosted on `DevDocs <https://devdocs.io/godot/>`__. To enable offline browsing on
|
||
DevDocs, you need to:
|
||
|
||
- Click the three dots in the top-left corner, choose **Preferences**.
|
||
- Enable the desired version of the Godot documentation by checking the box
|
||
next to it in the sidebar.
|
||
- Click the three dots in the top-left corner, choose **Offline data**.
|
||
- Click the **Install** link next to the Godot documentation.
|
||
|
||
You can also `download an HTML copy <https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-html-master.zip>`__
|
||
for offline reading (updated every Monday). Extract the ZIP archive then open
|
||
the top-level ``index.html`` in a web browser.
|
||
|
||
|
||
.. Below is the main table-of-content tree of the documentation website.
|
||
It is hidden on the page itself, but it makes up the sidebar for navigation.
|
||
|
||
.. toctree::
|
||
:hidden:
|
||
:maxdepth: 1
|
||
:caption: About
|
||
:name: sec-general
|
||
|
||
about/introduction
|
||
about/faq
|
||
about/troubleshooting
|
||
about/list_of_features
|
||
about/docs_changelog
|
||
about/release_policy
|
||
about/complying_with_licenses
|
||
|
||
.. toctree::
|
||
:hidden:
|
||
:maxdepth: 1
|
||
:caption: Getting started
|
||
:name: sec-learn
|
||
|
||
getting_started/introduction/index
|
||
getting_started/step_by_step/index
|
||
getting_started/first_2d_game/index
|
||
getting_started/first_3d_game/index
|
||
|
||
|
||
.. Sections below are split into two groups. First come meta sections, covering
|
||
general matters. Below that different areas of the engine are listed.
|
||
These sections are sorted alphabetically. Please keep them that way.
|
||
.. toctree::
|
||
:hidden:
|
||
:maxdepth: 1
|
||
:caption: Manual
|
||
:name: sec-tutorials
|
||
|
||
tutorials/best_practices/index
|
||
tutorials/editor/index
|
||
|
||
tutorials/2d/index
|
||
tutorials/3d/index
|
||
tutorials/animation/index
|
||
tutorials/assets_pipeline/index
|
||
tutorials/audio/index
|
||
tutorials/export/index
|
||
tutorials/i18n/index
|
||
tutorials/inputs/index
|
||
tutorials/io/index
|
||
tutorials/math/index
|
||
tutorials/navigation/index
|
||
tutorials/networking/index
|
||
tutorials/performance/index
|
||
tutorials/physics/index
|
||
tutorials/platform/index
|
||
tutorials/plugins/index
|
||
tutorials/rendering/index
|
||
tutorials/scripting/index
|
||
tutorials/shaders/index
|
||
tutorials/ui/index
|
||
tutorials/vr/index
|
||
|
||
|
||
.. toctree::
|
||
:hidden:
|
||
:maxdepth: 1
|
||
:caption: Development
|
||
:name: sec-devel
|
||
|
||
development/compiling/index
|
||
development/cpp/index
|
||
development/editor/index
|
||
development/file_formats/index
|
||
|
||
|
||
.. toctree::
|
||
:hidden:
|
||
:maxdepth: 1
|
||
:caption: Community
|
||
:name: sec-community
|
||
|
||
community/contributing/index
|
||
community/asset_library/index
|
||
community/channels
|
||
community/tutorials
|
||
|
||
|
||
.. toctree::
|
||
:hidden:
|
||
:maxdepth: 1
|
||
:caption: Class reference
|
||
:name: sec-class-ref
|
||
|
||
classes/index
|