godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-03 05:48:42 +03:00
Code Issues Packages Projects Releases Wiki Activity
5,252 Commits 20 Branches 0 Tags
3.4
Commit Graph

174 Commits

Author SHA1 Message Date
Hugo Locurcio
55543f7bac Tweak arguments in the VS Code configuration guide 
- Use the long name for the `--editor` option to make it more obvious.
- Document how to run a project directly while debugging.
- Put comments above the line to avoid horizontal overflow.
 2020-05-30 22:46:05 +02:00
Dean Brettle
8fb5c787aa Add --path option to sample VS Code launch.json (#3617) 2020-05-30 22:18:53 +02:00
Rémi Verschelde
8f6b4a2ace Merge branch 'master' into 3.2 2020-05-27 13:45:21 +02:00
Hugo Locurcio
43410b3c86 Tweak LD_LIBRARY_PATH export to work with paths that contain spaces (#3585) 
This also uses the `$PWD` environment variable which should always
be defined. It's also minutely faster than calling `$(pwd)` or using
the deprecated backtick syntax.
 2020-05-26 14:24:56 +02:00
Andrii Doroshenko
9539091084 Document custom_modules build option (#3595) 
* Document `custom_modules` build option
 2020-05-26 14:23:15 +02:00
Hugo Locurcio
47b0721d8a Capitalize all instances of Git in the documentation 2020-05-23 18:34:55 +02:00
Yuri Sizov
c0b566cce1 Adjusted language and layout of configuring an IDE docs 2020-05-21 17:34:08 +03:00
Rémi Verschelde
10f20b00cb Merge branch 'master' into 3.2 2020-05-20 15:08:42 +02:00
Max Hilbrunner
7371968b82 Merge pull request #3006 from Relintai/module-doc-fix 
Improve the 'Writing custom documentation' section
 2020-05-20 11:30:31 +02:00
Hugo Locurcio
ec77f48d5e Add documentation about exporting for dedicated servers 
This also documents how to build dedicated server binaries.
The part about compiling will need to be updated for Godot 4.0
once the server platform is usable again.

This also removes prompts before commands so that they can be
copy-pasted by triple-clicking without selecting the prompt.
 2020-05-19 21:52:23 +02:00
Relintai
01bec86e2d Improve the 'Writing custom documentation' section. 2020-05-19 19:07:53 +02:00
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
0a9fc75dc0 Merge branch 'master' into 3.2 2020-04-27 12:18:11 +02:00
Rémi Verschelde
e6b00ca97a Misc formatting fixes 2020-04-27 12:17:47 +02:00
Rémi Verschelde
c0cc4698f8 Merge branch 'master' into 3.2 2020-04-27 09:58:35 +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
Rémi Verschelde
707237278e Merge branch 'master' into 3.2 2020-04-21 14:08:07 +02:00
Trams
eb4b3e4d12 Correction in object_class.rst (#3409) 2020-04-19 15:21:52 +02:00
Rémi Verschelde
997fc68e78 Merge branch 'master' into 3.2 2020-04-17 19:09:14 +02:00
Rémi Verschelde
48faee9f73 Merge branch 'master' into 3.2 2020-04-17 19:09:11 +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
241887247a Revert master changes which are specific to 4.0+ 2020-03-13 17:08:48 +01: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