Commit Graph

107 Commits

Author SHA1 Message Date
Hugo Locurcio
e24fee75cb Split IDE instructions into several pages, improve writing style
This removes the link to the KDevelop setup video tutorial as it's
now outdated.

IDE screenshots were also optimized losslessly using
`oxipng -o6 --strip --zopfli`.

See #3485.
2020-05-08 22:03:03 +02:00
Andrii Doroshenko
387882f458 Document GDScript export category and property grouping (#3444)
* Document GDScript export category and property grouping

* Update getting_started/scripting/gdscript/gdscript_exports.rst

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2020-05-04 16:26:18 +02:00
Rémi Verschelde
e6b00ca97a Misc formatting fixes 2020-04-27 12:17:47 +02:00
Rémi Verschelde
e4237e2948 Misc fixes to recent merges 2020-04-27 09:58:08 +02:00
Shlomi
b294afe3e4 Visual Studio Configure Setup and Debugging (#3116)
* Visual Studio Configure Setup and Debugging

My first doc contribution!

* Apply suggestions from Calinou

Co-Authored-By: Hugo Locurcio <hugo.locurcio@hugo.pro>
Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2020-04-26 22:16:01 +02:00
Trams
eb4b3e4d12 Correction in object_class.rst (#3409) 2020-04-19 15:21:52 +02:00
Hugo Locurcio
046215542d Fix some typos and grammar mistakes found using LanguageTool 2020-04-16 23:07:05 +02:00
Yuri Sizov
4acf7a6563 Fix syntax highlighting for various languages (#3387) 2020-04-15 16:33:20 +02:00
Hugo Locurcio
6fb8d9b5de Rename all instances of the x11 platform to linuxbsd
Export template binaries haven't been renamed yet, so their names
were left as-is.
2020-04-01 09:15:45 +02:00
Rémi Verschelde
11b4a4a91a Fix code errors and style issues after #2750 2020-03-13 16:29:45 +01:00
Andrii Doroshenko
5b39f781ae Document modules ability to pre-register types (#3250)
`preregister_*_types()` is available to modules since
Vulkan branch has been merged.
2020-03-10 11:12:56 +01:00
Hugo Locurcio
63bea370f4 Fix invalid JSON in Custom resource format loaders (#3236)
Comments aren't allowed in JSON, so the note must be put outside
the example.
2020-03-10 10:37:58 +01:00
Yuri Sizov
37604be65f Improved keystroke formatting for shortcuts and key press menti… (#3257) 2020-03-09 23:50:53 +01:00
99alfie
6349d303af replaced erroneous sourcecode parts, added resource saver (#2750)
* replaced erroneous sourcecode parts, added resource saver

* changed spaces to tabs

* changed tabs to 4space+tab(s)

* Update development/cpp/custom_resource_format_loaders.rst

Co-Authored-By: Hugo Locurcio <hugo.locurcio@hugo.pro>

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2020-03-02 13:53:07 +01:00
Ilya Ryzhenkov
3439f85bb2 Fix incorrect name of JetBrains company (#3225) 2020-03-01 21:36:38 +01:00
Rémi Verschelde
1df5a0ae68 Merge pull request #3061 from asynts/asynts.syntax-highlighting-2
Incorrect syntax highlighting for languages other than GDScript.
2020-01-27 08:39:00 +01:00
Hugo Locurcio
4b1502e4e1 Mention export template caveats when creating a C++ module
See https://github.com/godotengine/godot/issues/35299.
2020-01-20 17:45:43 +01:00
DDL-Blue
03076b11d6 CLion IDE added to the "Configuring an IDE" page. (#3021)
* CLion IDE added to the "Configuring an IDE" page.

* Language and markup fixes

Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2020-01-17 13:48:15 +01:00
asynts
53f878bdaf Replace 'code' directives with 'code-block' directives.
The `code` directive highlights all sources as GDScript. Other languages are
highlighted incorrectly at the moment, even if `.. code:: [language]` is
specified.

It does, however, work with the `code-block` directive. The reason seems to be
that this directive is Sphinx specific.
2020-01-13 18:45:39 +01:00
asynts
3dede275f4 Use literal blocks for code samples with GDScript.
GDScript is already the default, it's redundant to specify it explicitly.
A [literal block][1] is already enough.

  [1]: https://www.sphinx-doc.org/en/1.8/usage/restructuredtext/basics.html#rst-literal-blocks
2020-01-13 18:45:39 +01:00
asynts
faf9472dda Use the correct language in code blocks.
There are a few places where no language is specified for a code block and
the default is incorrect.

There are a few places where pseudo code is treated as C++.
2020-01-13 18:45:39 +01:00
Rémi Verschelde
48306dc559 Fix singal typo in image name and tutorial 2019-12-03 10:12:40 +01:00
Fredia Huya-Kouadio
93b3c5f251 Add IDE configuration for Android studio (#2798) 2019-10-29 12:25:09 +01:00
Arron
8dfd49b12a minor grammar changes
Revised directions to read more clearly.
2019-10-26 13:42:54 -07:00
frido
2f4b025b14 Fix some typos in 'development' and 'getting started' sections 2019-10-10 23:51:29 +02:00
skyace65
f2fe133e01 Add note about parameter limit in C++ modules 2019-09-28 12:05:48 -04:00
Andrii Doroshenko (Xrayez)
209af20763 Describe the process of creating editor icons globally and per module
Also created a new `Editor development` chapter/section to encompass
C++ editor development side specifically which is not necessarily
related to pure core development, generic types and patterns.
2019-09-01 23:41:48 +03:00
Remi Rampin
91897778b2 [Minor] Fix "it's" that should be "its" (#2595)
* Fix "it's" that should be "its"

* Other fixes
2019-07-15 17:44:07 +09:00
Rémi Verschelde
4beac25f03 Proofread SCons examples 2019-07-03 09:46:30 +02:00
Juan Linietsky
3d58f51aa6 Added documentation about the new Custom Build system for Android 2019-04-24 17:02:45 -03:00
follower
3282d8f429 Minor typo/grammar fix: "you" -> "your"
Although I suspect this could be better written as something like:

> **Note**: You have to ``export`` the environment variable otherwise
> you won't be able to play your project from within the editor.
2019-04-14 17:49:46 +12:00
Rémi Verschelde
1e3ee988bb Fix typo in Android modules doc 2019-03-07 11:27:35 +01:00
Nathan Banks
053418ef6f Update custom_modules_in_cpp.rst
Fixed a typo.

(cherry picked from commit 955666e8b4)
2019-03-01 23:53:25 +01:00
Heinich Porro
f7c9c326cf Update broken links (#2207)
* Update broken link

There was a reference to core/dvector.h file insead of core/pool_vector.h

* updated another broken link
2019-02-25 13:50:41 +01:00
Rémi Verschelde
5b2aaf8d41 Optimize PNGs with optipng
Using `find -name "*.png" -exec optipng \;` and optipng 0.7.7
2019-01-26 22:10:03 +01:00
Rémi Verschelde
aa7a9f8675 Misc heading fixes 2019-01-08 11:30:55 +01:00
Wilson E. Alvarez
e7a3db9f1f Changed object->cast_to to Object::cast_to 2018-12-10 19:25:45 -05:00
Rémi Verschelde
4ef06a4135 Removing trailing whitespace
With `sed -i $(rg -l '[[:blank:]]*$' -g'!classes') -e 's/[[:blank:]]*$//g'`
2018-11-20 11:08:34 +01:00
Rémi Verschelde
a0e32ac017 Fix mixed use of tabs and spaces in indented blocks
4-space is our convention for indented blocks and should be used consistently.
The only exception is for C++ code which is tab-indented, as the engine code.
2018-11-20 11:02:11 +01:00
Karen S
6274c53536 Add android_add_asset_dir doc to "Creating Android modules" (#1894) 2018-11-20 10:10:45 +01:00
Rémi Verschelde
d146b1c13a Merge pull request #1890 from mijo-gracanin/master
Add instructions for configuring VS Code
2018-11-20 10:00:18 +01:00
Rémi Verschelde
3a6fa1507c Merge pull request #1892 from Calinou/capitalize-godot
Capitalize all instances of Godot (except the binary name)
2018-11-20 09:55:17 +01:00
Michael Alexsander Silva Dias
2d019998b5 Fix small problems in the "External libraries" and "Custom modules" pages 2018-11-15 14:06:32 -02:00
m
affa0f3542 Added example for binding to external C++ libary #513
Updated the custom C++ modules documentation with an example of binding to an external C++ library, using the Festival text-to-speech library.
2018-11-10 19:15:12 -05:00
mgracanin
b826cd9606 Add instructions for configuring VS Code 2018-10-31 23:50:03 +01:00
Hugo Locurcio
adf3cb915a Capitalize all instances of Godot (except the binary name) 2018-10-27 21:01:11 +02:00
Max Hilbrunner
079527b9d3 Merge pull request #1854 from LittleWhite-tb/indent-style-qt-creator
Qt Creator configuration to follow Godot's coding style
2018-10-21 21:44:50 +02:00
Max Hilbrunner
143305b108 Merge pull request #1863 from LittleWhite-tb/kdevelop-configuration-fixes
Fixes and improvement to the KDevelop documentation
2018-10-21 21:44:30 +02:00
Alexandre LittleWhite Laurent
430f6ef871 Fixes and improvement to the KDevelop documentation 2018-10-16 22:16:13 +02:00
Alexandre LittleWhite Laurent
0f69d5f0e1 New KDevelop screenshots 2018-10-16 22:02:20 +02:00