Add toctrees for new repo organization

Also renamed Getting started back to Step by step as requested by reduz.
This commit is contained in:
Rémi Verschelde
2017-03-29 20:18:10 +02:00
parent b408bdb918
commit fcbab02811
44 changed files with 387 additions and 22 deletions

12
about/index.rst Normal file
View File

@@ -0,0 +1,12 @@
About
=====
.. toctree::
:maxdepth: 1
:name: toc-about
faq
.. history
.. authors
.. license

View File

@@ -1,5 +1,5 @@
Class reference
===============
Godot API
=========
.. toctree::
:maxdepth: 1

View File

@@ -0,0 +1,10 @@
Contributing
============
.. toctree::
:maxdepth: 1
:name: toc-community-contributing
bug_triage_guidelines
doc_and_l10n_guidelines
updating_the_class_reference

View File

@@ -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

View File

@@ -0,0 +1,10 @@
Tutorials
=========
.. toctree::
:maxdepth: 1
:name: toc-community-tutorials
3d/index
.. external_resources

View File

@@ -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

15
development/cpp/index.rst Normal file
View File

@@ -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

View File

@@ -0,0 +1,8 @@
Editor plugins
==============
.. toctree::
:maxdepth: 1
:name: toc-devel-plugins
making_plugins

View File

@@ -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
:caption: General
:name: sec-general
about/index
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
.. 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
.. ------------------

13
learning/editor/index.rst Normal file
View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -0,0 +1,8 @@
Animation
=========
.. toctree::
:maxdepth: 1
:name: toc-learn-features-animation
cutout_animation

View File

@@ -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

View File

@@ -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

View File

@@ -0,0 +1,9 @@
Inputs
======
.. toctree::
:maxdepth: 1
:name: toc-learn-features-inputs
inputevent
mouse_and_input_coordinates

View File

@@ -0,0 +1,9 @@
Lighting
========
.. toctree::
:maxdepth: 1
:name: toc-learn-features-lighting
lighting
shadow_mapping

View File

@@ -0,0 +1,9 @@
Math
====
.. toctree::
:maxdepth: 1
:name: toc-learn-features-math
vector_math
matrices_and_transforms

View File

@@ -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

View File

@@ -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

View File

@@ -0,0 +1,10 @@
Physics
=======
.. toctree::
:maxdepth: 1
:name: toc-learn-features-physics
physics_introduction
ray-casting
kinematic_character_2d

View File

@@ -0,0 +1,9 @@
Platform-specific
=================
.. toctree::
:maxdepth: 1
:name: toc-learn-features-platform
android_in_app_purchases
services_for_ios

View File

@@ -0,0 +1,10 @@
Shading
=======
.. toctree::
:maxdepth: 1
:name: toc-learn-features-shading
shading_language
shader_materials
screen-reading_shaders

View File

@@ -0,0 +1,9 @@
Viewports
=========
.. toctree::
:maxdepth: 1
:name: toc-learn-features-viewports
viewports
multiple_resolutions

View File

@@ -0,0 +1,10 @@
GDScript
========
.. toctree::
:maxdepth: 1
:name: toc-learn-scripting-gdscript
gdscript_basics
gdscript_advanced
gdscript_format_string

View File

@@ -0,0 +1,8 @@
Scripting
=========
.. toctree::
:maxdepth: 1
:name: toc-learn-scripting
gdscript/index

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -0,0 +1,10 @@
Project workflow
================
.. toctree::
:maxdepth: 1
:name: toc-learn-workflow
project_setup/index
assets/index
export/index

View File

@@ -0,0 +1,11 @@
Project setup
=============
.. toctree::
:maxdepth: 1
:name: toc-learn-workflow-project_setup
project_organization
.. plugins_from_assetlib
.. cvs