index.rst 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  1. .. Godot Engine documentation master file, created by
  2. sphinx-quickstart on Sat Dec 12 16:57:47 2015.
  3. You can adapt this file completely to your liking, but it should at least
  4. contain the root `toctree` directive.
  5. Godot Docs – *master* branch
  6. ============================
  7. .. attention:: This is the documentation for the unstable (master) branch.
  8. Looking for the documentation of the current **stable** branch?
  9. `Have a look here <http://docs.godotengine.org/en/stable>`_.
  10. Welcome to the official documentation of Godot Engine, the free and open source
  11. community-driven 2D and 3D game engine! If you are new to this documentation,
  12. we recommend that you read the :ref:`introduction page <doc_about_intro>` to
  13. get an overview of what this documentation has to offer.
  14. The table of contents below and in the sidebar should let you easily access the
  15. documentation for your topic of interest. You can also use the search function
  16. in the top left corner.
  17. .. note:: Godot Engine is an open source project developed by a community of
  18. volunteers. It means that the documentation team can always use your
  19. feedback and help to improve the tutorials and class reference. If
  20. you do not manage to understand something, or cannot find what you
  21. are looking for in the docs, help us make the documentation better
  22. by letting us know!
  23. Submit an issue or pull request on the `GitHub repository
  24. <https://github.com/godotengine/godot-docs/issues>`_, or discuss with
  25. us on the #godotengine-doc IRC channel on freenode!
  26. The main documentation for the site is organized into the following sections:
  27. .. toctree::
  28. :maxdepth: 1
  29. :caption: General
  30. :name: sec-general
  31. about/index
  32. .. toctree::
  33. :maxdepth: 1
  34. :caption: Getting started
  35. :name: sec-learn
  36. getting_started/step_by_step/index
  37. getting_started/editor/index
  38. getting_started/scripting/index
  39. getting_started/workflow/index
  40. .. toctree::
  41. :maxdepth: 1
  42. :caption: Tutorials
  43. :name: sec-tutorials
  44. tutorials/2d/index
  45. tutorials/3d/index
  46. tutorials/audio/index
  47. tutorials/physics/index
  48. tutorials/math/index
  49. tutorials/animation/index
  50. tutorials/inputs/index
  51. tutorials/io/index
  52. tutorials/i18n/index
  53. tutorials/gui/index
  54. tutorials/viewports/index
  55. tutorials/shading/index
  56. tutorials/networking/index
  57. tutorials/assetlib/index
  58. tutorials/vr/index
  59. tutorials/plugins/index
  60. tutorials/platform/index
  61. tutorials/misc/index
  62. tutorials/debug/index
  63. .. toctree::
  64. :maxdepth: 1
  65. :caption: Development
  66. :name: sec-devel
  67. development/compiling/index
  68. development/cpp/index
  69. development/file_formats/index
  70. .. toctree::
  71. :maxdepth: 1
  72. :caption: Community
  73. :name: sec-community
  74. community/index
  75. .. toctree::
  76. :maxdepth: 1
  77. :caption: Class reference
  78. :name: sec-class-ref
  79. classes/index
  80. .. Indices and tables
  81. .. ------------------
  82. ..
  83. .. * :ref:`genindex`
  84. .. * :ref:`modindex`
  85. .. * :ref:`search`