Commit Graph
23 Commits
Author SHA1 Message Date
Danil Alexeev 3946ede7aa Replace remaining uses of shorthand codeblock syntax, add CI check 2025-07-25 16:20:16 -04:00
A Thousand Ships 92cd36b50e Various grammar and spelling fixes 2025-06-23 16:37:26 +02:00
Hugo Locurcio 8a6ad4c926 Replace uses of shorthand codeblock syntax to avoid issues with localization
Previously, many paragraphs in the documentation used `::` at the end of a line
as a replacement for a single colon (and `::` on the following line).
Due to this, the `::` was part of the extracted string for localization.
Weblate also showed a warning about the trailing `::`, as it's not
normally expected to be there.

This change requires translators to revalidate all modified strings.
However, considering many of those have broken code blocks due to translators
replacing `::` with `:`, it can be a good idea.

This also adds documentation writing guidelines for code blocks and admonitions.
This commit does not modify existing admonitions in any way (as this would
lead to a much larger diff, and require more localizable text to be revalidated
by translators).
2025-05-30 02:02:30 +02:00
Hugo Locurcio 039f8d7a19 Add a troubleshooting section to Compiling for macOS/iOS 2025-02-08 16:56:24 +01:00
Pāvels Nadtočajevs 61b891e334 Add notes about automatic .app bundle creation to compiling for macOS page. 2025-01-31 12:56:35 +02:00
Hugo Locurcio f1d751b4a9 Mention Vulkan and Direct3D 12 SDK install scripts in Compiling for macOS/Windows 2025-01-03 18:50:26 +01:00
Hugo Locurcio 59d97a7331 Remove instructions on setting up Pyston for faster development
This is done for several reasons:

- Recent CPython versions such as 3.13 have mostly caught up
  with Pyston in terms of performance. If the trend continues,
  CPython may supersede Pyston's performance in the long term.
  This is especially the case if the experimental JIT is
  eventually able to run Godot's SCons setup.
- Pyston is not maintained anymore (its last release was in 2022),
  and the last Python version it can run is 3.8. Python 3.8 is now
  end-of-life. Godot's SCons setup (as well as SCons itself) will
  eventually require Python versions newer than 3.8.
2024-11-29 02:05:45 +01:00
Jonathan Sekela 9057f15806 Add dev_build and dev_mode flags to scons compilation instructions for desktop editor pages 2024-11-19 19:55:33 -05:00
Thaddeus Crews a12dfff799 Bump minimum SCons/Python for builds 2024-11-14 10:01:37 -06:00
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
Rémi Verschelde 55f6c52037 Compiling: Min versions are now SCons 3.1.2 and GCC 9 2024-05-17 11:24:51 +02:00
Aaron Franke 65f2d2b36f Update export template docs to use Godot 4.x target names 2023-12-19 14:48:58 -06:00
Max Hilbrunner 0c79e66498 Merge pull request #7953 from adamscott/remove-old-target
Remove reference to old target in the macOS docs
2023-10-06 13:28:40 +02:00
Andrew Ogden e0ac48eb91 Modifying documentation to use correct editor executable file names 2023-09-27 12:22:42 -07:00
Adam Scott d7e300c01d Remove reference to old target in the macOS docs 2023-09-18 16:17:41 -04:00
f73951f580 explicit the need for code signing when creating an .app of the editor (#7527)
Co-authored-by: bruvzg <7645683+bruvzg@users.noreply.github.com>
Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2023-07-22 21:30:26 +02:00
Aaron Franke e79fc215ab macOS: Move Vulkan SDK from a note to a requirement 2023-07-07 19:38:49 -05:00
Ron B. Yeh 9d2f8420e3 Fix typo on "linker". 2023-03-30 14:39:44 -07:00
John Veness 08498ef96a Change capitalization of Project Manager 2023-03-13 20:08:49 +00:00
Hugo Locurcio 9a361d1ecf Remove most mentions of SCons -j parameter as it's now set automatically
The Introduction to the buildsystem page still mentions this parameter
in case it needs to be changed, but in most situations, the default
value of `(number of CPU threads) - 1` does a good job.
2023-01-24 13:17:21 +01:00
Hugo Locurcio 14e4b0e110 Document using Pyston-lite for faster builds on macOS 2023-01-22 11:01:14 +01:00
Hugo Locurcio 554394c5cd Update Python version requirements on Compiling pages
The `master` branch has required Python 3.6 to be compiled for
a few years now.

This also makes the text more consistent across platforms.
2023-01-20 13:07:35 +01:00
Yuri Sizov dbfe3b1d26 Reorganize documentation for contributors
- Merge Community/Contributing and Engine Development into one top-level section, Contributing.
- Structure it in a way that gives equal priority to various ways to contribute, including documentation.
- Rename several articles to be more comprehensive and in line with the overall state of the documentation.
- Rewrite the guide for class reference contributions.
2023-01-10 01:49:30 +03:00