godot-docs/index.rst

88 lines
2.4 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

.. Godot Engine documentation master file, created by
sphinx-quickstart on Sat Dec 12 16:57:47 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Godot Docs *master* branch
============================
.. attention:: This is the documentation for the unstable (master) branch.
Looking for the documentation of the current **stable** branch?
`Have a look here <http://docs.godotengine.org/en/stable>`_.
Welcome to the official documentation of Godot Engine, 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 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.
.. note:: Godot Engine is an open source project developed by a community of
volunteers. It means that the documentation team can always use your
feedback and help to improve the tutorials and class reference. If
you do not manage to 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>`_, or discuss with
us on the #godotengine-devel IRC channel!
The main documentation for the site is organized into the following sections:
.. toctree::
:maxdepth: 1
:caption: General
:name: sec-general
about/index
.. toctree::
:maxdepth: 1
:caption: Learning
:name: sec-learn
learning/step_by_step/index
learning/editor/index
learning/features/index
learning/scripting/index
learning/workflow/index
.. toctree::
:maxdepth: 1
:caption: Development
:name: sec-devel
development/plugins/index
development/compiling/index
development/cpp/index
.. toctree::
:maxdepth: 1
:caption: Community
:name: sec-community
community/contributing/index
community/tutorials/index
.. toctree::
:maxdepth: 1
:caption: Class reference
:name: sec-class-ref
classes/index
.. Indices and tables
.. ------------------
..
.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`