Add toctrees for new repo organization

Also renamed Getting started back to Step by step as requested by reduz.
95camarones · Apr 3, 2017 · fcbab02 · fcbab02
1 parent b408bdb
commit fcbab02
Show file tree

Hide file tree

Showing 44 changed files with 388 additions and 23 deletions.
diff --git a/about/index.rst b/about/index.rst
@@ -0,0 +1,12 @@
+About
+=====
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-about
+
+   faq
+
+.. history
+.. authors
+.. license
diff --git a/classes/_classes.rst → classes/index.rst b/classes/_classes.rst → classes/index.rst
@@ -1,5 +1,5 @@
-Class reference
-===============
+Godot API
+=========
 
 .. toctree::
    :maxdepth: 1

diff --git a/community/contributing/index.rst b/community/contributing/index.rst
@@ -0,0 +1,10 @@
+Contributing
+============
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-community-contributing
+
+   bug_triage_guidelines
+   doc_and_l10n_guidelines
+   updating_the_class_reference
diff --git a/community/tutorials/3d/index.rst b/community/tutorials/3d/index.rst
@@ -0,0 +1,10 @@
+3D
+==
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-community-tutorials-3d
+
+   mesh_generation_with_heightmap_and_shaders
+   working_with_3d_skeletons
+   inverse_kinematics
diff --git a/community/tutorials/index.rst b/community/tutorials/index.rst
@@ -0,0 +1,10 @@
+Tutorials
+=========
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-community-tutorials
+
+   3d/index
+
+.. external_resources
diff --git a/development/compiling/index.rst b/development/compiling/index.rst
@@ -0,0 +1,18 @@
+Compiling
+=========
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-devel-compiling
+
+   introduction_to_the_buildsystem
+   compiling_for_windows
+   compiling_for_x11
+   compiling_for_osx
+   compiling_for_android
+   compiling_for_ios
+   cross-compiling_for_ios_on_linux
+   compiling_for_uwp
+   compiling_for_web
+   batch_building_templates
+   packaging_godot
diff --git a/development/cpp/index.rst b/development/cpp/index.rst
@@ -0,0 +1,15 @@
+Developing in C++
+=================
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-devel-cpp
+
+   introduction_to_godot_development
+   configuring_an_ide
+   core_types
+   variant_class
+   object_class
+   inheritance_class_tree
+   custom_modules_in_cpp
+   creating_android_modules
diff --git a/development/plugins/index.rst b/development/plugins/index.rst
@@ -0,0 +1,8 @@
+Editor plugins
+==============
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-devel-plugins
+
+   making_plugins
diff --git a/index.rst b/index.rst
@@ -18,41 +18,60 @@ or annoy us at the #godotengine-devel IRC channel!
 
 The main documentation for the site is organized into a few sections:
 
-* :ref:`sec-tutorials`
-* :ref:`sec-reference`
+* :ref:`sec-general`
+* :ref:`sec-learn`
+* :ref:`sec-devel`
 * :ref:`sec-community`
+* :ref:`sec-class-ref`
+
+--------------
 
 .. toctree::
    :maxdepth: 1
-   :caption: Tutorials
-   :name: sec-tutorials
-
-   tutorials/step_by_step/_step_by_step
-   tutorials/engine/_engine
-   tutorials/2d/_2d
-   tutorials/3d/_3d
-   tutorials/_networking
-   tutorials/_plugins
-   tutorials/_misc_tutorials
-   tutorials/asset_pipeline/_asset_pipeline
+   :caption: General
+   :name: sec-general
+
+   about/index
+
 
 .. toctree::
    :maxdepth: 1
-   :caption: Reference
-   :name: sec-reference
+   :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
 
-   classes/_classes
-   reference/_languages
-   reference/_cheat_sheets
-   reference/_compiling
-   reference/_advanced
 
 .. toctree::
    :maxdepth: 1
    :caption: Community
    :name: sec-community
 
-   contributing/_contributing
+   community/contributing/index
+   community/tutorials/index
+
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Class reference
+   :name: sec-class-ref
+
+   classes/index
+
 
 .. Indices and tables
 .. ------------------

diff --git a/learning/editor/index.rst b/learning/editor/index.rst
@@ -0,0 +1,13 @@
+Editor manual
+=============
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-editor
+
+   2d_and_3d_keybindings
+   unity_to_godot
+   command_line_tutorial
+
+.. ue4_to_godot
+.. debugging
diff --git a/learning/features/2d/index.rst b/learning/features/2d/index.rst
@@ -0,0 +1,12 @@
+2D
+==
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features-2d
+
+   2d_transforms
+   canvas_layers
+   using_tilemaps
+   custom_drawing_in_2d
+   particle_systems_2d
diff --git a/learning/features/3d/index.rst b/learning/features/3d/index.rst
@@ -0,0 +1,15 @@
+3D
+==
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features-3d
+
+   introduction_to_3d
+   3d_performance_and_limitations
+   importing_3d_meshes
+   importing_3d_scenes
+   materials
+   fixed_materials
+   high_dynamic_range
+   using_gridmaps
diff --git a/learning/features/animation/index.rst b/learning/features/animation/index.rst
@@ -0,0 +1,8 @@
+Animation
+=========
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features-animation
+
+   cutout_animation
diff --git a/learning/features/gui/index.rst b/learning/features/gui/index.rst
@@ -0,0 +1,13 @@
+GUI
+===
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features-gui
+
+   gui_skinning
+   custom_gui_controls
+   size_and_anchors
+   bbcode_in_richtextlabel
+
+.. gui_containers
diff --git a/learning/features/index.rst b/learning/features/index.rst
@@ -0,0 +1,22 @@
+Engine features
+===============
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features
+
+   math/index
+   2d/index
+   3d/index
+   gui/index
+   physics/index
+   viewports/index
+   inputs/index
+   animation/index
+   lighting/index
+   shading/index
+   networking/index
+   platform/index
+   misc/index
+
+.. audio/index
diff --git a/learning/features/inputs/index.rst b/learning/features/inputs/index.rst
@@ -0,0 +1,9 @@
+Inputs
+======
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features-inputs
+
+   inputevent
+   mouse_and_input_coordinates
diff --git a/learning/features/lighting/index.rst b/learning/features/lighting/index.rst
@@ -0,0 +1,9 @@
+Lighting
+========
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features-lighting
+
+   lighting
+   shadow_mapping
diff --git a/learning/features/math/index.rst b/learning/features/math/index.rst
@@ -0,0 +1,9 @@
+Math
+====
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features-math
+
+   vector_math
+   matrices_and_transforms
diff --git a/learning/features/misc/index.rst b/learning/features/misc/index.rst
@@ -0,0 +1,16 @@
+Miscellaneous
+=============
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features-misc
+
+   background_loading
+   data_paths
+   saving_games
+   encrypting_save_games
+   handling_quit_requests
+   pausing_games
+   internationalizing_games
+   locales
+   binary_serialization_api
diff --git a/learning/features/networking/index.rst b/learning/features/networking/index.rst
@@ -0,0 +1,12 @@
+Networking
+==========
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features-networking
+
+   high_level_multiplayer
+   http_client_class
+   ssl_certificates
+
+.. managing_tcp_udp_connections.rst
diff --git a/learning/features/physics/index.rst b/learning/features/physics/index.rst
@@ -0,0 +1,10 @@
+Physics
+=======
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features-physics
+
+   physics_introduction
+   ray-casting
+   kinematic_character_2d
diff --git a/learning/features/platform/index.rst b/learning/features/platform/index.rst
@@ -0,0 +1,9 @@
+Platform-specific
+=================
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features-platform
+
+   android_in_app_purchases
+   services_for_ios
diff --git a/learning/features/shading/index.rst b/learning/features/shading/index.rst
@@ -0,0 +1,10 @@
+Shading
+=======
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features-shading
+
+   shading_language
+   shader_materials
+   screen-reading_shaders
diff --git a/learning/features/viewports/index.rst b/learning/features/viewports/index.rst
@@ -0,0 +1,9 @@
+Viewports
+=========
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features-viewports
+
+   viewports
+   multiple_resolutions
diff --git a/learning/scripting/gdscript/index.rst b/learning/scripting/gdscript/index.rst
@@ -0,0 +1,10 @@
+GDScript
+========
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-scripting-gdscript
+
+   gdscript_basics
+   gdscript_advanced
+   gdscript_format_string
diff --git a/learning/scripting/index.rst b/learning/scripting/index.rst
@@ -0,0 +1,8 @@
+Scripting
+=========
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-scripting
+
+   gdscript/index
diff --git a/learning/getting_started/animations.rst → learning/step_by_step/animations.rst b/learning/getting_started/animations.rst → learning/step_by_step/animations.rst
diff --git a/learning/getting_started/filesystem.rst → learning/step_by_step/filesystem.rst b/learning/getting_started/filesystem.rst → learning/step_by_step/filesystem.rst
diff --git a/learning/getting_started/gui_tutorial.rst → learning/step_by_step/gui_tutorial.rst b/learning/getting_started/gui_tutorial.rst → learning/step_by_step/gui_tutorial.rst