index.rst 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  1. Godot Docs – *master* branch
  2. ============================
  3. .. only:: not i18n
  4. .. note:: Godot's documentation is available in various languages and versions.
  5. Expand the "Read the Docs" panel at the bottom of the sidebar to see
  6. the list.
  7. .. only:: i18n
  8. .. note:: This documentation is translated from the `original English one
  9. <https://docs.godotengine.org/en/latest>`_ by community members
  10. on `Weblate <https://hosted.weblate.org/projects/godot-engine/godot-docs>`_.
  11. Depending on the translation effort's completion level, you may
  12. find paragraphs or whole pages which are still in English. You can
  13. help the community by providing new translations or reviewing existing
  14. ones on Weblate.
  15. For the time being, localized translations are only available for
  16. the "latest" (development) branch, but should be suitable to learn
  17. how to use stable Godot releases nevertheless.
  18. Welcome to the official documentation of `Godot Engine <https://godotengine.org>`__,
  19. the free and open source community-driven 2D and 3D game engine! If you are new
  20. to this documentation, we recommend that you read the
  21. :ref:`introduction page <doc_about_intro>` to get an overview of what this
  22. documentation has to offer.
  23. The table of contents below and in the sidebar should let you easily access the
  24. documentation for your topic of interest. You can also use the search function
  25. in the top left corner.
  26. .. note:: Godot Engine is an open source project developed by a community of
  27. volunteers. The documentation team can always use your
  28. feedback and help to improve the tutorials and class reference. If
  29. you don't understand something, or cannot find what you
  30. are looking for in the docs, help us make the documentation better
  31. by letting us know!
  32. Submit an issue or pull request on the `GitHub repository
  33. <https://github.com/godotengine/godot-docs/issues>`_,
  34. help us `translate the documentation
  35. <https://hosted.weblate.org/engage/godot-engine/>`_ into your
  36. language, or talk to us on either the ``#documentation``
  37. channel on `Discord <https://discord.gg/zH7NUgz>`_, or the
  38. ``#godotengine-doc`` channel on `irc.freenode.net
  39. <http://webchat.freenode.net/?channels=#godotengine-doc>`_!
  40. .. centered:: |weblate_widget|
  41. The main documentation for the site is organized into the following sections:
  42. .. toctree::
  43. :maxdepth: 1
  44. :caption: General
  45. :name: sec-general
  46. about/index
  47. .. toctree::
  48. :maxdepth: 1
  49. :caption: Getting started
  50. :name: sec-learn
  51. getting_started/introduction/index
  52. getting_started/step_by_step/index
  53. .. The sections below are sorted alphabetically. Please keep them that way.
  54. .. toctree::
  55. :maxdepth: 1
  56. :caption: Tutorials
  57. :name: sec-tutorials
  58. tutorials/2d/index
  59. tutorials/3d/index
  60. tutorials/animation/index
  61. tutorials/assets_pipeline/index
  62. tutorials/audio/index
  63. tutorials/best_practices/index
  64. tutorials/editor/index
  65. tutorials/export/index
  66. tutorials/i18n/index
  67. tutorials/inputs/index
  68. tutorials/io/index
  69. tutorials/math/index
  70. tutorials/networking/index
  71. tutorials/performance/index
  72. tutorials/physics/index
  73. tutorials/platform/index
  74. tutorials/plugins/index
  75. tutorials/rendering/index
  76. tutorials/scripting/index
  77. tutorials/shaders/index
  78. tutorials/ui/index
  79. tutorials/vr/index
  80. .. toctree::
  81. :maxdepth: 1
  82. :caption: Development
  83. :name: sec-devel
  84. development/compiling/index
  85. development/cpp/index
  86. development/editor/index
  87. development/file_formats/index
  88. .. toctree::
  89. :maxdepth: 1
  90. :caption: Community
  91. :name: sec-community
  92. community/contributing/index
  93. community/asset_library/index
  94. community/channels
  95. community/tutorials
  96. .. toctree::
  97. :maxdepth: 1
  98. :caption: Class reference
  99. :name: sec-class-ref
  100. classes/index
  101. .. Indices and tables
  102. .. ------------------
  103. ..
  104. .. * :ref:`genindex`
  105. .. * :ref:`modindex`
  106. .. * :ref:`search`