Browse Source

Merge pull request #1028 from mhilbrunner/docs-structure

Restructuring update
Nathan Lovato 7 years ago
parent
commit
96ee7418e9
60 changed files with 101 additions and 31 deletions
  1. 46 0
      community/channels.rst
  2. 11 0
      community/index.rst
  3. 11 0
      community/resources.rst
  4. 12 0
      community/tutorials.rst
  5. 0 10
      community/tutorials/3d/index.rst
  6. 0 12
      community/tutorials/index.rst
  7. 4 5
      index.rst
  8. 0 0
      tutorials/3d/img/10_Blender_exportUV.png
  9. 0 0
      tutorials/3d/img/11_Godot.png
  10. 0 0
      tutorials/3d/img/14_Godot_LoadMesh.png
  11. 0 0
      tutorials/3d/img/15_Godot_MeshPlaneRendered.png
  12. 0 0
      tutorials/3d/img/16_Godot_ShaderMaterial.png
  13. 0 0
      tutorials/3d/img/17_Godot_newMaterialShader.png
  14. 0 0
      tutorials/3d/img/18_Godot_ShaderEditorOpened.png
  15. 0 0
      tutorials/3d/img/19_Godot_BlackPlane.png
  16. 0 0
      tutorials/3d/img/1_GIMP_createImage512.png
  17. 0 0
      tutorials/3d/img/20_Godot_TexturedPlane.png
  18. 0 0
      tutorials/3d/img/21_Godot_Fini.png
  19. 0 0
      tutorials/3d/img/2_GIMP.png
  20. 0 0
      tutorials/3d/img/3_GIMP_FilterRenderClouds.png
  21. 0 0
      tutorials/3d/img/4_GIMP_Clouds.png
  22. 0 0
      tutorials/3d/img/5_Blender.png
  23. 0 0
      tutorials/3d/img/6_Blender_CreatePlane.png
  24. 0 0
      tutorials/3d/img/7_Blender_subdivided.png
  25. 0 0
      tutorials/3d/img/8_Blender_UVSmart.png
  26. 0 0
      tutorials/3d/img/9_Blender_UV_editor.png
  27. 0 0
      tutorials/3d/img/inverse_kinematics.png
  28. 0 0
      tutorials/3d/img/inverse_kinematics.svg
  29. 3 0
      tutorials/3d/index.rst
  30. 0 0
      tutorials/3d/inverse_kinematics.rst
  31. 0 0
      tutorials/3d/mesh_generation_with_heightmap_and_shaders.rst
  32. 0 0
      tutorials/3d/working_with_3d_skeletons.rst
  33. 0 0
      tutorials/platform/consoles.rst
  34. 1 0
      tutorials/platform/index.rst
  35. 0 0
      tutorials/plugins/editor/img/import_plugin_options.png
  36. 0 0
      tutorials/plugins/editor/img/import_plugin_trying.png
  37. 0 0
      tutorials/plugins/editor/img/making_plugins-custom_dock.png
  38. 0 0
      tutorials/plugins/editor/img/making_plugins-custom_node_console.png
  39. 0 0
      tutorials/plugins/editor/img/making_plugins-custom_node_create.png
  40. 0 0
      tutorials/plugins/editor/img/making_plugins-custom_node_icon.png
  41. 0 0
      tutorials/plugins/editor/img/making_plugins-my_custom_dock_scene.png
  42. 0 0
      tutorials/plugins/editor/img/making_plugins-my_custom_mode_folder.png
  43. 0 0
      tutorials/plugins/editor/img/making_plugins-project_settings.png
  44. 0 0
      tutorials/plugins/editor/import_plugins.rst
  45. 1 1
      tutorials/plugins/editor/index.rst
  46. 0 0
      tutorials/plugins/editor/making_plugins.rst
  47. 0 0
      tutorials/plugins/gdnative/gdnative-c-example.rst
  48. 0 0
      tutorials/plugins/gdnative/img/add_main_script.gif
  49. 0 0
      tutorials/plugins/gdnative/img/c_main_scene_layout.png
  50. 0 0
      tutorials/plugins/gdnative/img/c_sample_result.png
  51. 0 0
      tutorials/plugins/gdnative/img/connect_button_signal.gif
  52. 0 0
      tutorials/plugins/gdnative/img/nativescript_library.png
  53. 0 0
      tutorials/plugins/gdnative/img/nativescript_resource.png
  54. 0 0
      tutorials/plugins/gdnative/img/new_resource.gif
  55. 0 0
      tutorials/plugins/gdnative/img/save_gdns.gif
  56. 2 2
      tutorials/plugins/gdnative/index.rst
  57. 9 0
      tutorials/plugins/index.rst
  58. 0 0
      tutorials/vr/img/minimum_setup.png
  59. 1 1
      tutorials/vr/index.rst
  60. 0 0
      tutorials/vr/vr_primer.rst

+ 46 - 0
community/channels.rst

@@ -0,0 +1,46 @@
+.. _doc_community_channels:
+
+Channels
+========
+
+So, where is the Godot community and where can you ask questions and get help?
+
+Note that some of these channels are run and moderated by members of the Godot community or third parties.
+
+A brief overview over these channels is also available on the `website <https://godotengine.org/community>`_.
+
+Q & A
+-----
+
+- `Official Godot Questions & Answers <https://godotengine.org/qa/>`_
+
+IRC on Freenode
+---------------
+
+- `General: #godotengine <http://webchat.freenode.net/?channels=#godotengine>`_
+- `Engine development: #godotengine-devel <http://webchat.freenode.net/?channels=#godotengine-devel>`_
+- `Documentation: #godotengine-doc <http://webchat.freenode.net/?channels=#godotengine-doc>`_
+- `GDNative: #godotengine-gdnative <http://webchat.freenode.net/?channels=#godotengine-gdnative>`_
+- `Webseite/PR: #godotengine-atelier <http://webchat.freenode.net/?channels=#godotengine-atelier>`_
+- `IRC logs <https://godot.eska.me/irc-logs/>`_
+
+Other chats
+-----------
+
+- `Matrix (IRC compatible) <https://matrix.to/#/#godotengine:matrix.org>`_
+- `Discord <https://discord.gg/zH7NUgz>`_
+
+Social networks
+---------------
+
+- `GitHub <https://github.com/godotengine/>`_
+- `Facebook group <https://www.facebook.com/groups/godotengine/>`_
+- `Twitter (also, #godotengine) <https://twitter.com/godotengine>`_
+- `Reddit <https://www.reddit.com/r/godot>`_
+- `Youtube <https://www.youtube.com/c/GodotEngineOfficial>`_
+- `Steam <https://steamcommunity.com/app/404790>`_
+
+Forum
+-----
+
+- `Forum (godotdevelopers.org) <http://godotdevelopers.org/>`_

+ 11 - 0
community/index.rst

@@ -0,0 +1,11 @@
+Community
+=========
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-community
+
+   contributing/index
+   channels
+   tutorials
+   resources

+ 11 - 0
community/resources.rst

@@ -0,0 +1,11 @@
+.. _doc_community_resources:
+
+Resources
+=========
+
+This is a list of third-party resources created by the community that may be of interest.
+
+General
+---------------
+
+- `awesome-godot: A curated list of resources by Calinou <https://github.com/Calinou/awesome-godot>`_

+ 12 - 0
community/tutorials.rst

@@ -0,0 +1,12 @@
+.. _doc_community_tutorials:
+
+Tutorials
+=========
+
+This is a list of third-party tutorials created by the community that may be of interest.
+
+Video tutorials
+---------------
+
+- `GDQuest <https://www.youtube.com/channel/UCxboW7x0jZqFdvMdCFKTMsQ/playlists>`_
+- `KidsCanCode <https://www.youtube.com/channel/UCNaPQ5uLX5iIEHUCLmfAgKg/playlists>`_

+ 0 - 10
community/tutorials/3d/index.rst

@@ -1,10 +0,0 @@
-3D
-==
-
-.. toctree::
-   :maxdepth: 1
-   :name: toc-community-tutorials-3d
-
-   mesh_generation_with_heightmap_and_shaders
-   working_with_3d_skeletons
-   inverse_kinematics

+ 0 - 12
community/tutorials/index.rst

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

+ 4 - 5
index.rst

@@ -68,18 +68,18 @@ The main documentation for the site is organized into the following sections:
    tutorials/shading/index
    tutorials/networking/index
    tutorials/assetlib/index
-   tutorials/misc/index
+   tutorials/vr/index
+   tutorials/plugins/index
    tutorials/platform/index
+   tutorials/misc/index
 
 .. toctree::
    :maxdepth: 1
    :caption: Development
    :name: sec-devel
 
-   development/plugins/index
    development/compiling/index
    development/cpp/index
-   development/consoles/consoles
 
 
 .. toctree::
@@ -87,8 +87,7 @@ The main documentation for the site is organized into the following sections:
    :caption: Community
    :name: sec-community
 
-   community/contributing/index
-   community/tutorials/index
+   community/index
 
 
 .. toctree::

+ 0 - 0
community/tutorials/3d/img/10_Blender_exportUV.png → tutorials/3d/img/10_Blender_exportUV.png


+ 0 - 0
community/tutorials/3d/img/11_Godot.png → tutorials/3d/img/11_Godot.png


+ 0 - 0
community/tutorials/3d/img/14_Godot_LoadMesh.png → tutorials/3d/img/14_Godot_LoadMesh.png


+ 0 - 0
community/tutorials/3d/img/15_Godot_MeshPlaneRendered.png → tutorials/3d/img/15_Godot_MeshPlaneRendered.png


+ 0 - 0
community/tutorials/3d/img/16_Godot_ShaderMaterial.png → tutorials/3d/img/16_Godot_ShaderMaterial.png


+ 0 - 0
community/tutorials/3d/img/17_Godot_newMaterialShader.png → tutorials/3d/img/17_Godot_newMaterialShader.png


+ 0 - 0
community/tutorials/3d/img/18_Godot_ShaderEditorOpened.png → tutorials/3d/img/18_Godot_ShaderEditorOpened.png


+ 0 - 0
community/tutorials/3d/img/19_Godot_BlackPlane.png → tutorials/3d/img/19_Godot_BlackPlane.png


+ 0 - 0
community/tutorials/3d/img/1_GIMP_createImage512.png → tutorials/3d/img/1_GIMP_createImage512.png


+ 0 - 0
community/tutorials/3d/img/20_Godot_TexturedPlane.png → tutorials/3d/img/20_Godot_TexturedPlane.png


+ 0 - 0
community/tutorials/3d/img/21_Godot_Fini.png → tutorials/3d/img/21_Godot_Fini.png


+ 0 - 0
community/tutorials/3d/img/2_GIMP.png → tutorials/3d/img/2_GIMP.png


+ 0 - 0
community/tutorials/3d/img/3_GIMP_FilterRenderClouds.png → tutorials/3d/img/3_GIMP_FilterRenderClouds.png


+ 0 - 0
community/tutorials/3d/img/4_GIMP_Clouds.png → tutorials/3d/img/4_GIMP_Clouds.png


+ 0 - 0
community/tutorials/3d/img/5_Blender.png → tutorials/3d/img/5_Blender.png


+ 0 - 0
community/tutorials/3d/img/6_Blender_CreatePlane.png → tutorials/3d/img/6_Blender_CreatePlane.png


+ 0 - 0
community/tutorials/3d/img/7_Blender_subdivided.png → tutorials/3d/img/7_Blender_subdivided.png


+ 0 - 0
community/tutorials/3d/img/8_Blender_UVSmart.png → tutorials/3d/img/8_Blender_UVSmart.png


+ 0 - 0
community/tutorials/3d/img/9_Blender_UV_editor.png → tutorials/3d/img/9_Blender_UV_editor.png


+ 0 - 0
community/tutorials/3d/img/inverse_kinematics.png → tutorials/3d/img/inverse_kinematics.png


+ 0 - 0
community/tutorials/3d/img/inverse_kinematics.svg → tutorials/3d/img/inverse_kinematics.svg


+ 3 - 0
tutorials/3d/index.rst

@@ -15,3 +15,6 @@
    environment_and_post_processing
    high_dynamic_range
    using_gridmaps
+   working_with_3d_skeletons
+   inverse_kinematics
+   mesh_generation_with_heightmap_and_shaders

+ 0 - 0
community/tutorials/3d/inverse_kinematics.rst → tutorials/3d/inverse_kinematics.rst


+ 0 - 0
community/tutorials/3d/mesh_generation_with_heightmap_and_shaders.rst → tutorials/3d/mesh_generation_with_heightmap_and_shaders.rst


+ 0 - 0
community/tutorials/3d/working_with_3d_skeletons.rst → tutorials/3d/working_with_3d_skeletons.rst


+ 0 - 0
development/consoles/consoles.rst → tutorials/platform/consoles.rst


+ 1 - 0
tutorials/platform/index.rst

@@ -7,3 +7,4 @@ Platform-specific
 
    android_in_app_purchases
    services_for_ios
+   consoles

+ 0 - 0
development/plugins/img/import_plugin_options.png → tutorials/plugins/editor/img/import_plugin_options.png


+ 0 - 0
development/plugins/img/import_plugin_trying.png → tutorials/plugins/editor/img/import_plugin_trying.png


+ 0 - 0
development/plugins/img/making_plugins-custom_dock.png → tutorials/plugins/editor/img/making_plugins-custom_dock.png


+ 0 - 0
development/plugins/img/making_plugins-custom_node_console.png → tutorials/plugins/editor/img/making_plugins-custom_node_console.png


+ 0 - 0
development/plugins/img/making_plugins-custom_node_create.png → tutorials/plugins/editor/img/making_plugins-custom_node_create.png


+ 0 - 0
development/plugins/img/making_plugins-custom_node_icon.png → tutorials/plugins/editor/img/making_plugins-custom_node_icon.png


+ 0 - 0
development/plugins/img/making_plugins-my_custom_dock_scene.png → tutorials/plugins/editor/img/making_plugins-my_custom_dock_scene.png


+ 0 - 0
development/plugins/img/making_plugins-my_custom_mode_folder.png → tutorials/plugins/editor/img/making_plugins-my_custom_mode_folder.png


+ 0 - 0
development/plugins/img/making_plugins-project_settings.png → tutorials/plugins/editor/img/making_plugins-project_settings.png


+ 0 - 0
development/plugins/import_plugins.rst → tutorials/plugins/editor/import_plugins.rst


+ 1 - 1
development/plugins/index.rst → tutorials/plugins/editor/index.rst

@@ -3,7 +3,7 @@ Editor plugins
 
 .. toctree::
    :maxdepth: 1
-   :name: toc-devel-plugins
+   :name: toc-tutorials-plugins
 
    making_plugins
    import_plugins

+ 0 - 0
development/plugins/making_plugins.rst → tutorials/plugins/editor/making_plugins.rst


+ 0 - 0
community/tutorials/gdnative/gdnative-c-example.rst → tutorials/plugins/gdnative/gdnative-c-example.rst


+ 0 - 0
community/tutorials/gdnative/img/add_main_script.gif → tutorials/plugins/gdnative/img/add_main_script.gif


+ 0 - 0
community/tutorials/gdnative/img/c_main_scene_layout.png → tutorials/plugins/gdnative/img/c_main_scene_layout.png


+ 0 - 0
community/tutorials/gdnative/img/c_sample_result.png → tutorials/plugins/gdnative/img/c_sample_result.png


+ 0 - 0
community/tutorials/gdnative/img/connect_button_signal.gif → tutorials/plugins/gdnative/img/connect_button_signal.gif


+ 0 - 0
community/tutorials/gdnative/img/nativescript_library.png → tutorials/plugins/gdnative/img/nativescript_library.png


+ 0 - 0
community/tutorials/gdnative/img/nativescript_resource.png → tutorials/plugins/gdnative/img/nativescript_resource.png


+ 0 - 0
community/tutorials/gdnative/img/new_resource.gif → tutorials/plugins/gdnative/img/new_resource.gif


+ 0 - 0
community/tutorials/gdnative/img/save_gdns.gif → tutorials/plugins/gdnative/img/save_gdns.gif


+ 2 - 2
community/tutorials/gdnative/index.rst → tutorials/plugins/gdnative/index.rst

@@ -1,8 +1,8 @@
-GDNATIVE
+GDNative
 ========
 
 .. toctree::
    :maxdepth: 1
-   :name: toc-community-tutorials-gdnative
+   :name: toc-tutorials-gdnative
 
    gdnative-c-example

+ 9 - 0
tutorials/plugins/index.rst

@@ -0,0 +1,9 @@
+Plugins
+=======
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-tutorials-extending
+
+   editor/index
+   gdnative/index

+ 0 - 0
community/tutorials/vr/img/minimum_setup.png → tutorials/vr/img/minimum_setup.png


+ 1 - 1
community/tutorials/vr/index.rst → tutorials/vr/index.rst

@@ -3,6 +3,6 @@ VR
 
 .. toctree::
    :maxdepth: 1
-   :name: toc-community-tutorials-vr
+   :name: toc-tutorials-vr
 
    vr_primer

+ 0 - 0
community/tutorials/vr/vr_primer.rst → tutorials/vr/vr_primer.rst