Commit Graph

215 Commits

Author SHA1 Message Date
Hugo Locurcio
4ab397cd5e Document generate_bundle=yes SCons option in Compiling for macOS and iOS
- Reorder instructions to mention ARM64 builds first in macOS,
  as this is the primary architecture in use now (with all new Macs
  since 2023 being sold with Apple Silicon only). The `lipo` command still
  works as before, as it infers the architecture from the input files.
- Remove the manual bundle generation steps to make the page shorter
  (similar to Compiling for Android).
- Remove references to the master branch (this was only relevant when
  4.0 was still in development).
2024-10-16 17:51:52 +02:00
Khalid Abuhakmeh
464e320df0 Update JetBrains Rider documentation (#10025)
Revised JetBrains Rider setup steps and clarified debug configurations. Replaced outdated .webp images with new .png files for newer and clearer screenshots.

Add a note clarifying that this documentation is intended for contributing to the game engine, not for using JetBrains Rider as a C# or GDScript editor. Include reference to the C# guide for configuring an external editor.

Fixed duplicate link based on the Sphinx format. This should fix the warning/error on the page.

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2024-10-07 16:47:41 +02:00
Matthew
6010454a38 Merge pull request #9947 from Repiteo/warning-admonition
Add `WARNING:` to list of admonitions
2024-09-28 11:03:04 -04:00
tetrapod00
283fe11715 Improve sidebar navigation by removing headers
- Ensure most pages are reachable through the sidebar, by removing headers on pages that are mostly indexes.
- This also means that some pages now have navigable headers again.
2024-09-23 01:32:56 -07:00
tetrapod00
eb4ab3a78e Clarify requirements in Compiling for Windows 2024-09-21 21:48:59 -07:00
Hugo Locurcio
93261ab5d7 Harmonize Bash command syntax for easier line selection and copy-pasting
- Remove prompt or `$` sign which makes triple-click based selection
  more difficult and time-consuming.
- Use `platform` instead of `p` alias in all SCons examples.
2024-09-15 16:27:34 +02:00
Thaddeus Crews
7d7d9c3dcc Add WARNING: to list of admonitions 2024-09-12 11:17:09 -05:00
Max Hilbrunner
459ec69f7c Merge pull request #9911 from Geometror/unit-testing-signalwatcher-section
Document testing signals
2024-09-09 13:01:35 +02:00
Matthew
598016681f Merge pull request #9899 from Geometror/note-about-create-test-py
Add note about the create_test.py script
2024-09-07 12:06:20 -04:00
Matthew
aa297fd23c Merge pull request #9862 from MBCX/riscv-cross-compilation
Add compilation instructions for RISC-V
2024-09-07 11:46:34 -04:00
Hendrik Brucker
fccf53259f Document testing signals 2024-09-05 17:05:17 +02:00
MBCX
2a85b24ec3 Add compilation instructions for RISC-V 2024-09-05 11:00:35 -04:00
Felix Bytow
d68f5ff0cd Mention --no-deprecated in Compiling with .NET 2024-09-04 18:27:25 +02:00
Hendrik Brucker
b07c27fdbe Add note about the create_test.py script 2024-09-04 16:40:33 +02:00
A Thousand Ships
728eb341fa [Contributing] Improve list of classes disabled by disable_advanced_gui 2024-08-28 15:20:16 +02:00
Kongfa Waroros
f27d12979d Update certain example code snippets to use the new syntax 2024-08-23 14:16:54 +07:00
Hugo Locurcio
49a432d066 Fix Visual Studio Code gdb pretty print script path to match the Godot repository 2024-08-17 20:31:26 +02:00
Matthew
b54f912c77 Merge pull request #9582 from russellsanborn/comma-before-but
Add commas before "but" throughout documentation
2024-08-15 21:35:04 -04:00
Max Hilbrunner
95eb1ba85e Merge pull request #9701 from Geometror/tests-add-special-tags-section
Add section about special tags to the unit testing guide
2024-08-04 16:50:31 +02:00
Max Hilbrunner
1b974d5535 Merge pull request #9700 from Geometror/tests-add-subcases-section
Add section about subcases to the unit testing guide
2024-08-04 16:49:22 +02:00
Hendrik Brucker
b85d63c69c Add section about special tags to the unit testing guide 2024-08-03 12:47:29 +02:00
Hendrik Brucker
012805ba82 Add section about subcases to the unit testing guide 2024-08-02 20:51:38 +02:00
Fredia Huya-Kouadio
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
Gio
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
Russell Sanborn
97f2823ee1 Remove "," in object_class.rst, add "code" to code_style_guidelines.rst 2024-07-27 08:31:03 -05:00
Russell Sanborn
7011117ccd Update contributing/development/core_and_modules/object_class.rst 2024-07-27 08:20:44 -05:00
Russell Sanborn
a71c5cd1db Update contributing/development/core_and_modules/core_types.rst 2024-07-27 08:20:18 -05: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
Joshua Goins
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
Russell Sanborn
5908691ea0 Update contributing/development/compiling/introduction_to_the_buildsystem.rst
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2024-07-09 13:59:04 -05:00
Russell Sanborn
0c10476a1d Update contributing/development/core_and_modules/object_class.rst
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2024-07-09 13:58:57 -05:00
Russell Sanborn
a3e4e9b0cc Add commas before "but" throughout documentation 2024-07-06 08:41:08 -05: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