Commit Graph

33 Commits

Author SHA1 Message Date
A Thousand Ships
92cd36b50e Various grammar and spelling fixes 2025-06-23 16:37:26 +02:00
Hugo Locurcio
c737b30d5d Mention the lack of debugger support in Running code in the editor 2025-04-22 14:38:51 +02:00
tetrapod00
6902e58d09 Reorder Output panel message categories to match order in editor 2025-02-15 18:28:54 -08:00
Harry Keightley
126dcf1b6d Switch ordering of *error* and *warning* in debug docs.
Error and Warning were incorrectly given each-other's descriptions. This change switches the sub-titles for each section.
2025-02-16 10:59:39 +09:00
tetrapod00
6311520290 Document limitation of Visual Profiler on macOS 2025-02-12 00:31:40 -08:00
tetrapod00
c4d3aa134a Standardize RST header syntax 2024-12-29 13:44:09 -08:00
skyace65
cb39d01e97 Update debugger visual profiler screenshot 2024-12-11 18:16:10 -05:00
Hugo Locurcio
806a4fccfd Add a page on the Output bottom panel 2024-12-07 08:40:44 +01:00
tetrapod00
7cfe4b82b1 Fix wrong editor setting in Overview of Debugging Tools 2024-11-19 11:58:55 -08:00
tetrapod00
6a11d113e7 Update list of debugging settings 2024-11-08 16:15:27 -08:00
Hugo Locurcio
36bb7e5ac5 Document expression evaluator in Debugger panel 2024-10-05 00:35:05 +02:00
Hugo Locurcio
be34108636 Document profiler autostart functionality 2024-09-16 23:33:41 +02:00
Hugo Locurcio
b95f46f078 Fix incorrect setup instructions in The profiler 2024-09-05 02:19:27 +02:00
gachipan
a2c22b4a3f Remove confusing end of sentence from the_profiler.rst documentation
Cut off the end of a sentence that doesn't make sense:

"You can also start profiling at any time before or during gameplay, depending on if you want."

It seems like removing the "depending on if you want." improves clarity of the documentation.
2024-08-31 13:51:54 -07:00
Christen Lofland
e939756910 Update Overview of Debugging Tools for 4.3. 2024-03-21 14:50:45 -05:00
skyace65
328da800dd Remove Godot 3 reference from profiler page 2024-02-08 22:24:31 -05:00
Hugo Locurcio
95fb178429 Add support for user-provided comments with Giscus
This allows users to leave comments on pages that don't have
`:allow_comments: False` somewhere in the page's source.
Both manual and class reference pages can receive comments.
Index pages cannot have comments, as discussion should occur on "leaf" pages.

GitHub Discussions is used as a backend on the same repository. This means
that Discussions *must* be enabled on godotengine/godot-docs before this
commit is merged to `master`. Users can choose to use the "Custom" watch
mode if they don't want to get notifications for discussion updates,
but still get notifications for issue and pull request updates.

User comments are intended to be used for the following purposes:

- Add a clarification or correct something in the documentation,
  without having to open a pull request. Contributors are encouraged to
  take a look at discussions from time to time, and see if there's information
  worth incorporating in the pages themselves. Don't forget to reply to
  the comment when doing so :)
- Mention a workaround for a common issue.
- Link to useful third-party resources that are relevant to the current page,
  such as tutorials or add-ons.

User comments should *not* be used for technical support. Other community
platforms should be used for that.

Page-to-discussion matching is done using the `pagename` Sphinx variable,
which is independent of the Godot version and documentation language.
Being independent of the Godot version allows keeping old comments
when the Godot version changes, while also allowing users from `/stable`
and `/4.1` to "see" each other in discussions.

See https://giscus.app for more information.
2024-01-11 17:51:53 +01:00
Hugo Locurcio
c15da78587 Fix unused image due to bad syntax in Custom performance monitors
Comment syntax was used instead of figure syntax.
2023-11-07 17:44:55 +01:00
NoctemCat
5561524ea9 Fixed typos in custom_performance_monitors.rst
Changed Monitor to Monitors and added missing colon in the link to Performance.add_custom_monitor
2023-10-31 11:22:32 +09:00
Luna
0fe7ff833e Fixed typos in several doc files (#8002)
* Fixed typos in
- c_sharp_differences.rst
- debugger_panel.rst
- gdextension_cpp_example.rst
- gui_using_fonts.rst
- openxr_hand_tracking.rst
- overview_of_debugging_tools.rst
- setting_up_xr.rst
- shading_language.rst
- the_profiler.rst
- your_second_3d_shader.rst

* Update tutorials/shaders/shader_reference/shading_language.rst

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

* PR Feedback

---------

Co-authored-by: Luna <2650849-Lunalicious@users.noreply.gitlab.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2023-09-25 00:41:33 +02:00
Max Hilbrunner
005213b3c6 Merge pull request #7278 from Calinou/gdscript-debugger-mention-thread-support 2023-07-27 01:03:08 +02:00
LeeWannacott
e2ed5d893c Update docs to use Time class rather than OS class. 2023-07-14 17:49:37 +12:00
Hugo Locurcio
b9268e8ee4 Remove outdated notices about GDScript debugger not supporting threads
This is now supported in Godot.
2023-05-04 12:57:05 +02:00
Hugo Locurcio
698c40e72a Document how to add breakpoints in the editor and using breakpoint
Until now, there was little documentation on how to create breakpoints
(including persistent ones with the `breakpoint` keyword). This may
not be obvious to those who haven't used other IDEs before.

This also documents' breakpoints persistent behavior since the editor
state is saved.
2023-05-03 20:26:46 +02:00
Hugo Locurcio
12ff0a170d Document the Visual Profiler debugger tab, update some screenshots to 4.0 (#6976)
* Document the Visual Profiler debugger tab, update some screenshots to 4.0

* Update tutorials/scripting/debug/debugger_panel.rst

Co-authored-by: Clay John <claynjohn@gmail.com>

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
Co-authored-by: Clay John <claynjohn@gmail.com>
2023-03-22 11:29:05 +01:00
Hugo Locurcio
62c1050bac Add a page on custom performance monitors (#6409) 2022-12-19 17:48:40 +01:00
yed podtrzitko
c6406c876a External Editor: add info about debugger setting option (#6253)
* External Editor: add info about debugger setting option

* Apply suggestions from code review

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2022-10-04 13:11:09 +02:00
Matthew
87d12d7533 Document Profiler C# limitations (#5779) 2022-04-29 12:33:58 +02:00
Aaron Franke
5c7f653347 Optimize PNG and SVG images using oxipng and svgcleaner (#5254) 2021-09-14 17:50:17 +02:00
hakankaraduman
013ff59734 Fix "physics time" instead of "physics frame" in The Profiler (#4899) 2021-05-10 14:48:08 +02:00
Nathan Lovato
9622480ffe Edit the_profiler.rst 2020-11-27 11:04:58 -06:00
skyace65
8e893ecf49 Add GDQuest profiler page 2020-11-23 10:57:32 -05:00
Nathan Lovato
9e91769f93 Move debug section to Scripting
Closes #4110
2020-10-09 10:09:09 -06:00