Commit Graph
187 Commits
Author SHA1 Message Date
Fredia Huya-KouadioandHugo Locurcio 73091bea0a Update the Android build documentation (#9669)
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2024-07-30 08:39:57 +02:00
wise_ 4b755c0dac Update tscn.rst (#9665)
fix a missing space
2024-07-28 20:29:24 -04:00
GioandHugo Locurcio 18ad4e72f3 Ubuntu APT oneliner to install system builtin alternatives (#9512)
* Ubuntu APT oneliner to install system builtin alternatives

Might work on Debian, not sure - tested on Ubuntu 24.04 LTS

* Use new table syntax (easier to maintain), add Debian

---------

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2024-07-29 00:11:19 +02:00
Max Hilbrunner 08b25ad636 Merge pull request #9650 from bruvzg/win_arm64
Update "Compiling for Windows" page.
2024-07-28 00:07:21 +02:00
skyace65 19ffef34f8 Update Docs for ARM support 2024-07-26 17:48:43 -04:00
bruvzg cbc0dda137 Update "Compiling for Windows" page. 2024-07-26 10:46:16 +03:00
e996398251 Mention single thread web template support (#9392)
* Mention single thread web template support

This is controlled  with the SCons option ``threads``. Now it's documented as another knob you can turn when compiling the web template.

* Update contributing/development/compiling/compiling_for_web.rst

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2024-07-22 16:20:57 +02:00
Max Hilbrunner 6ee50cb3a0 Merge pull request #9568 from Calinou/update-cross-compiling-ios-linux
Update Cross-compiling for iOS on Linux
2024-07-22 16:14:55 +02:00
Hugo Locurcio 71a606fce9 Update Cross-compiling for iOS on Linux
- Update link to Xcode download. Mention that it requires being
  logged into an Apple ID for the page to be visible.
- Remove DMG method as Xcode has been distributed in XIP archives
  since 2016.
2024-07-13 06:31:57 +02:00
Pedro J. Estébanez d2ccdb5154 Remove references to the no longer needed DXC 2024-07-11 12:32:14 +02:00
Hugo Locurcio e7fdb120c7 Fix dead links in the documentation
Command used:

    lychee **/*.rst --github-token="..." --accept="100..=103,200..=299,429"

429 error codes were allowed due to a high number of false positives,
even with a GitHub token specified.
2024-07-01 18:55:30 +02:00
skyace65 17a683682c Update name of where you get openJDK from 2024-06-28 18:57:55 -04:00
Matthew 9cb26f2a4a Merge pull request #9209 from Chubercik/ruff-formatter
Update Python code style guidelines regarding usage of `ruff`
2024-06-16 09:01:28 -04:00
Rémi Verschelde c1101c3978 Merge pull request #9158 from AThousandShips/compat_doc
Document how to handle compatibility breakages
2024-06-13 14:09:12 +02:00
Matthew 2b797d6362 Merge pull request #9474 from najmam/patch-1
Fix misplaced end of sentence
2024-06-12 20:22:09 -04:00
A Thousand Ships 3fafd46da6 Document how to handle compatibility breakages 2024-06-12 22:03:19 +02:00
Alex Drozd db172cf7c5 Correct typo in tscn docs 2024-06-09 18:13:01 +02:00
Naji Mammeri d27c7d026c Fix misplaced end of sentence 2024-06-09 00:59:44 +02:00
Max Hilbrunner 3dd0622cd2 Merge pull request #9465 from AThousandShips/indent_fix
Fix invalid indentation in various files
2024-06-08 05:28:55 +02:00
Matthew bac1cdd723 Merge pull request #9384 from Calinou/internal-rendering-architecture-opengl
Improve OpenGL documentation in Internal rendering architecture
2024-06-07 15:49:34 -04:00
A Thousand Ships 36e2351df2 Fix invalid indentation in various files 2024-06-06 16:16:45 +02:00
Anni Ryynänen b42f904796 Fix a typo: "and that you not introducing" 2024-06-05 17:12:31 +03:00
Max Hilbrunner 3a1a74842e Merge pull request #9232 from skyace65/InheritanceTree
Update inheritance tree images for 4.2
2024-06-05 06:25:22 +02:00
Jakub Marcowski 149931107b Update Python code style guidelines regarding usage of ruff 2024-05-31 20:03:48 +02:00
Hugo Locurcio 06bd5b3ccb Fix false positives in codespell CI and fix reported typos
- Don't install codespell when building offline docs
  as it's not needed in that workflow.
2024-05-31 10:58:12 +02:00
Hugo Locurcio 8e6067d143 Improve OpenGL documentation in Internal rendering architecture
- Mention that OpenGL ES can be run directly on desktop platforms
  with a command line argument.
- Remove notice about some OpenGL features being unimplemented,
  as the Compatibility rendering is pretty much feature-complete
  as of 4.3.
- Update URL for the Vulkan rendering driver to follow RenderingDeviceDriver
  changes.
- Fix incorrect notice about the D3D12 rendering driver transpiling
  GLSL to HLSL (it transpiles SPIR-V to DXIL instead).
2024-05-31 10:20:48 +02:00
Aaron Franke 1a7fd1ea5f Improve Compiling for iOS docs: Mention how to set up Xcode 2024-05-29 00:17:25 -07:00
Aaron Franke e3297dd7cd Improve Compiling for Android docs: Homebrew, GDExtension, terminal 2024-05-29 00:17:25 -07:00
Rémi Verschelde 55f6c52037 Compiling: Min versions are now SCons 3.1.2 and GCC 9 2024-05-17 11:24:51 +02:00
Fredia Huya-Kouadio 91a4273b2c Update the Android documentation for Godot 4.3 2024-05-14 23:32:45 -07:00
Matthew 8b2533d75d Merge pull request #9348 from Mitten-O/topic/document-gdb-prettyer
Document the possibility to enable custom pretty-printers in GDB
2024-05-12 19:39:12 -04:00
Max Hilbrunner 2fbda9eb30 Merge pull request #9357 from Calinou/compiling-for-linuxbsd-update-deps
Update dependencies in Compiling for Linux/*BSD
2024-05-12 12:53:34 +02:00
skyace65 3142f88b1f Update inheritance tree images 2024-05-11 22:28:18 -04:00
Aaron Franke 97e34daba4 Fix meaning of "scons" by itself in Introduction to the Buildsystem 2024-05-11 18:14:08 -07:00
Hugo Locurcio 27f9076302 Update dependencies in Compiling for Linux/*BSD
- List Wayland dependency and packages on most distributions.
- Use `sudo` on distributions that are set up to use it by default.
- Use unattended install-friendly commands (e.g. `-y` switch).
- Mention required commands to run before installing, such as
  `apt-get update`.
- Fix install commands on some distributions:
  - Alpine no longer packages libexecinfo since 3.17, so it was removed
    from the list.
  - Solus requires `-c` for `system.devel`.
- Reorder distributions so they're in alphabetical order.
2024-05-11 00:05:57 +02:00
Mitten Orvan 281bc8399e Document the possibility to enable custom pretty-printers in GDB
GDB pretty-printers were recently added for a couple Godot types.
They make the GDB debugger variable display more readable, so let's
document their existence for developers.
cf. godot/godot#91280
2024-05-07 21:17:39 +03:00
LunarTides 4aec1e094c Fix grammar mistake in scripting_development 2024-04-30 12:42:21 +02:00
Max Hilbrunner 160034a4ac Merge pull request #9188 from allenwp/annotation-improvements
Improve description of annotations
2024-04-30 04:19:10 +02:00
Allen Pestaluky 8dd09aa962 Improved description of annotations
Removes an unnecessary and potentially confusing comparison of annotations to keywords and generally improves wording in the GDScript Basics tutorial. A new page to the Contributing section has been added for scripting development guidelines. This new page hosts suggestions on when annotations should be implemented in GDScript.
2024-04-29 13:18:30 -04:00
Matthew adf3c32ec3 Merge pull request #9171 from Globostofo/master
Patched a minor typo in visual_studio_code.rst
2024-04-28 21:28:34 -04:00
Paul Joannon f300b404bb Update required SDK version on "compiling w/ .NET" 2024-04-23 23:31:34 +02:00
melquiadess dbe3a88377 Fix various minor typos 2024-04-20 16:41:23 +01:00
Mikael Hermansson 3279f8a8a8 Update the names of the export binaries 2024-04-17 12:26:18 +02:00
Hannah 54e795a623 Add new documentation about the pre-commit hook 2024-04-16 00:29:55 +08:00
Christen Lofland 4b47a47de0 Simplify the MSVC install instructions
This line can be simplified from:
`If installing Visual Studio 2017 or 2019, make sure to enable **C++** in
the list of workflows to install.`
To:
`Make sure to enable **C++** in the list of workflows to install.`

This line is not needed as we don't support 2015 anymore:
`If installing Visual Studio 2015, make sure to run a **Custom**
installation instead of **Typical** and select **C++** as a language there.`

This can be simplified from:
`If you've already made the mistake of installing Visual Studio without
C++ support, run the installer again; it should present you a **Modify** button.`
To:
`If you've already installed Visual Studio without C++ support, run the installer
again; it should present you a **Modify** button.`

From my checking on my system, this line is no longer true, so we can remove it:
`Running the installer from *Add/Remove Programs* will only give you
a **Repair** option, which won't let you install C++ tools.`

Now we can move the simplified text up so that the reader does not have to dig through the entire document to find that important bit of information, while not making the text at the top much longer due removing outdated information.
2024-04-11 10:22:27 -05:00
Romain CLEMENT 7624db9dc0 Patched a minor typo in visual_studio_code.rst 2024-04-01 17:56:54 +02:00
A Thousand Ships bd6cc665a7 Fix incorrect uses of a/an 2024-03-29 15:14:27 +01:00
kit cf54259ff0 Add intellisense configuration for VSCode 2024-03-22 09:54:22 -04:00
Matthew 809e728db0 Merge pull request #8983 from Calinou/compiling-for-linuxbsd-production
Clarify `production=yes` SCons option in Compiling for Linux/*BSD
2024-03-13 19:33:57 -04:00
A Thousand Ships 54a8d084bf [Navigation] Document 3D support is required for navigation 2024-03-06 15:45:22 +01:00