From fcbab02811dc0f354c5950073e3d3eb0a50efce3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Wed, 29 Mar 2017 20:18:10 +0200 Subject: [PATCH] Add toctrees for new repo organization Also renamed Getting started back to Step by step as requested by reduz. --- about/index.rst | 12 ++++ classes/{_classes.rst => index.rst} | 4 +- community/contributing/index.rst | 10 +++ community/tutorials/3d/index.rst | 10 +++ community/tutorials/index.rst | 10 +++ development/compiling/index.rst | 18 ++++++ development/cpp/index.rst | 15 +++++ development/plugins/index.rst | 8 +++ index.rst | 61 ++++++++++++------- learning/editor/index.rst | 13 ++++ learning/features/2d/index.rst | 12 ++++ learning/features/3d/index.rst | 15 +++++ learning/features/animation/index.rst | 8 +++ learning/features/gui/index.rst | 13 ++++ learning/features/index.rst | 22 +++++++ learning/features/inputs/index.rst | 9 +++ learning/features/lighting/index.rst | 9 +++ learning/features/math/index.rst | 9 +++ learning/features/misc/index.rst | 16 +++++ learning/features/networking/index.rst | 12 ++++ learning/features/physics/index.rst | 10 +++ learning/features/platform/index.rst | 9 +++ learning/features/shading/index.rst | 10 +++ learning/features/viewports/index.rst | 9 +++ learning/scripting/gdscript/index.rst | 10 +++ learning/scripting/index.rst | 8 +++ .../animations.rst | 0 .../filesystem.rst | 0 .../gui_tutorial.rst | 0 learning/step_by_step/index.rst | 20 ++++++ .../instancing.rst | 0 .../instancing_continued.rst | 0 .../resources.rst | 0 .../scene_tree.rst | 0 .../scenes_and_nodes.rst | 0 .../scripting.rst | 0 .../scripting_continued.rst | 0 .../simple_2d_game.rst | 0 .../singletons_autoload.rst | 0 .../splash_screen.rst | 0 learning/workflow/assets/index.rst | 14 +++++ learning/workflow/export/index.rst | 14 +++++ learning/workflow/index.rst | 10 +++ learning/workflow/project_setup/index.rst | 11 ++++ 44 files changed, 388 insertions(+), 23 deletions(-) create mode 100644 about/index.rst rename classes/{_classes.rst => index.rst} (70%) create mode 100644 community/contributing/index.rst create mode 100644 community/tutorials/3d/index.rst create mode 100644 community/tutorials/index.rst create mode 100644 development/compiling/index.rst create mode 100644 development/cpp/index.rst create mode 100644 development/plugins/index.rst create mode 100644 learning/editor/index.rst create mode 100644 learning/features/2d/index.rst create mode 100644 learning/features/3d/index.rst create mode 100644 learning/features/animation/index.rst create mode 100644 learning/features/gui/index.rst create mode 100644 learning/features/index.rst create mode 100644 learning/features/inputs/index.rst create mode 100644 learning/features/lighting/index.rst create mode 100644 learning/features/math/index.rst create mode 100644 learning/features/misc/index.rst create mode 100644 learning/features/networking/index.rst create mode 100644 learning/features/physics/index.rst create mode 100644 learning/features/platform/index.rst create mode 100644 learning/features/shading/index.rst create mode 100644 learning/features/viewports/index.rst create mode 100644 learning/scripting/gdscript/index.rst create mode 100644 learning/scripting/index.rst rename learning/{getting_started => step_by_step}/animations.rst (100%) rename learning/{getting_started => step_by_step}/filesystem.rst (100%) rename learning/{getting_started => step_by_step}/gui_tutorial.rst (100%) create mode 100644 learning/step_by_step/index.rst rename learning/{getting_started => step_by_step}/instancing.rst (100%) rename learning/{getting_started => step_by_step}/instancing_continued.rst (100%) rename learning/{getting_started => step_by_step}/resources.rst (100%) rename learning/{getting_started => step_by_step}/scene_tree.rst (100%) rename learning/{getting_started => step_by_step}/scenes_and_nodes.rst (100%) rename learning/{getting_started => step_by_step}/scripting.rst (100%) rename learning/{getting_started => step_by_step}/scripting_continued.rst (100%) rename learning/{getting_started => step_by_step}/simple_2d_game.rst (100%) rename learning/{getting_started => step_by_step}/singletons_autoload.rst (100%) rename learning/{getting_started => step_by_step}/splash_screen.rst (100%) create mode 100644 learning/workflow/assets/index.rst create mode 100644 learning/workflow/export/index.rst create mode 100644 learning/workflow/index.rst create mode 100644 learning/workflow/project_setup/index.rst diff --git a/about/index.rst b/about/index.rst new file mode 100644 index 00000000000..efaa843e3ba --- /dev/null +++ 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 b/classes/index.rst similarity index 70% rename from classes/_classes.rst rename to classes/index.rst index 37aa66b2584..fa23d6fa201 100644 --- a/classes/_classes.rst +++ b/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 new file mode 100644 index 00000000000..544a670f3a9 --- /dev/null +++ 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 new file mode 100644 index 00000000000..b9579bd5bd9 --- /dev/null +++ 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 new file mode 100644 index 00000000000..a4f259d77ef --- /dev/null +++ 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 new file mode 100644 index 00000000000..ff57319a609 --- /dev/null +++ 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 new file mode 100644 index 00000000000..dde85524459 --- /dev/null +++ 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 new file mode 100644 index 00000000000..9b5cf6a473b --- /dev/null +++ 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 index 7b357b269ca..647511a436a 100644 --- 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 new file mode 100644 index 00000000000..e7e996c9f98 --- /dev/null +++ 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 new file mode 100644 index 00000000000..4d74228163f --- /dev/null +++ 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 new file mode 100644 index 00000000000..c10ffa72098 --- /dev/null +++ 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 new file mode 100644 index 00000000000..01cf7e0ff12 --- /dev/null +++ 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 new file mode 100644 index 00000000000..0fc0c8f8141 --- /dev/null +++ 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 new file mode 100644 index 00000000000..7a3208058ca --- /dev/null +++ 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 new file mode 100644 index 00000000000..2df5163e986 --- /dev/null +++ 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 new file mode 100644 index 00000000000..011b8c9745d --- /dev/null +++ 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 new file mode 100644 index 00000000000..5a9cc258992 --- /dev/null +++ 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 new file mode 100644 index 00000000000..d1ee7040d40 --- /dev/null +++ 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 new file mode 100644 index 00000000000..9ca5fc243ee --- /dev/null +++ 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 new file mode 100644 index 00000000000..38eda2db1f4 --- /dev/null +++ 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 new file mode 100644 index 00000000000..f0480b9c88e --- /dev/null +++ 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 new file mode 100644 index 00000000000..773b26e8945 --- /dev/null +++ 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 new file mode 100644 index 00000000000..bc78ead8cfe --- /dev/null +++ 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 new file mode 100644 index 00000000000..8d294feb565 --- /dev/null +++ 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 new file mode 100644 index 00000000000..b549fce8d3c --- /dev/null +++ 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 b/learning/step_by_step/animations.rst similarity index 100% rename from learning/getting_started/animations.rst rename to learning/step_by_step/animations.rst diff --git a/learning/getting_started/filesystem.rst b/learning/step_by_step/filesystem.rst similarity index 100% rename from learning/getting_started/filesystem.rst rename to learning/step_by_step/filesystem.rst diff --git a/learning/getting_started/gui_tutorial.rst b/learning/step_by_step/gui_tutorial.rst similarity index 100% rename from learning/getting_started/gui_tutorial.rst rename to learning/step_by_step/gui_tutorial.rst diff --git a/learning/step_by_step/index.rst b/learning/step_by_step/index.rst new file mode 100644 index 00000000000..a9bb13a530e --- /dev/null +++ b/learning/step_by_step/index.rst @@ -0,0 +1,20 @@ +Step by step +============ + +.. toctree:: + :maxdepth: 1 + :name: toc-learn-step_by_step + + scenes_and_nodes + instancing + instancing_continued + scripting + scripting_continued + simple_2d_game + gui_tutorial + splash_screen + animations + resources + filesystem + scene_tree + singletons_autoload diff --git a/learning/getting_started/instancing.rst b/learning/step_by_step/instancing.rst similarity index 100% rename from learning/getting_started/instancing.rst rename to learning/step_by_step/instancing.rst diff --git a/learning/getting_started/instancing_continued.rst b/learning/step_by_step/instancing_continued.rst similarity index 100% rename from learning/getting_started/instancing_continued.rst rename to learning/step_by_step/instancing_continued.rst diff --git a/learning/getting_started/resources.rst b/learning/step_by_step/resources.rst similarity index 100% rename from learning/getting_started/resources.rst rename to learning/step_by_step/resources.rst diff --git a/learning/getting_started/scene_tree.rst b/learning/step_by_step/scene_tree.rst similarity index 100% rename from learning/getting_started/scene_tree.rst rename to learning/step_by_step/scene_tree.rst diff --git a/learning/getting_started/scenes_and_nodes.rst b/learning/step_by_step/scenes_and_nodes.rst similarity index 100% rename from learning/getting_started/scenes_and_nodes.rst rename to learning/step_by_step/scenes_and_nodes.rst diff --git a/learning/getting_started/scripting.rst b/learning/step_by_step/scripting.rst similarity index 100% rename from learning/getting_started/scripting.rst rename to learning/step_by_step/scripting.rst diff --git a/learning/getting_started/scripting_continued.rst b/learning/step_by_step/scripting_continued.rst similarity index 100% rename from learning/getting_started/scripting_continued.rst rename to learning/step_by_step/scripting_continued.rst diff --git a/learning/getting_started/simple_2d_game.rst b/learning/step_by_step/simple_2d_game.rst similarity index 100% rename from learning/getting_started/simple_2d_game.rst rename to learning/step_by_step/simple_2d_game.rst diff --git a/learning/getting_started/singletons_autoload.rst b/learning/step_by_step/singletons_autoload.rst similarity index 100% rename from learning/getting_started/singletons_autoload.rst rename to learning/step_by_step/singletons_autoload.rst diff --git a/learning/getting_started/splash_screen.rst b/learning/step_by_step/splash_screen.rst similarity index 100% rename from learning/getting_started/splash_screen.rst rename to learning/step_by_step/splash_screen.rst diff --git a/learning/workflow/assets/index.rst b/learning/workflow/assets/index.rst new file mode 100644 index 00000000000..dac63098883 --- /dev/null +++ b/learning/workflow/assets/index.rst @@ -0,0 +1,14 @@ +Assets workflow +=============== + +.. toctree:: + :maxdepth: 1 + :name: toc-learn-workflow-assets + + import_process + managing_image_files + importing_textures + importing_audio_samples + importing_fonts + importing_translations + exporting_images diff --git a/learning/workflow/export/index.rst b/learning/workflow/export/index.rst new file mode 100644 index 00000000000..5d974a94b86 --- /dev/null +++ b/learning/workflow/export/index.rst @@ -0,0 +1,14 @@ +Export +====== + +.. toctree:: + :maxdepth: 1 + :name: toc-learn-workflow-export + + exporting_projects + exporting_for_pc + exporting_for_ios + exporting_for_uwp + exporting_for_android + exporting_for_web + one-click_deploy diff --git a/learning/workflow/index.rst b/learning/workflow/index.rst new file mode 100644 index 00000000000..d6414d0c5bc --- /dev/null +++ b/learning/workflow/index.rst @@ -0,0 +1,10 @@ +Project workflow +================ + +.. toctree:: + :maxdepth: 1 + :name: toc-learn-workflow + + project_setup/index + assets/index + export/index diff --git a/learning/workflow/project_setup/index.rst b/learning/workflow/project_setup/index.rst new file mode 100644 index 00000000000..38f3d698d60 --- /dev/null +++ b/learning/workflow/project_setup/index.rst @@ -0,0 +1,11 @@ +Project setup +============= + +.. toctree:: + :maxdepth: 1 + :name: toc-learn-workflow-project_setup + + project_organization + +.. plugins_from_assetlib +.. cvs