Stowage/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-10-31 13:41:03 +00:00
Code Issues Projects Releases Packages Wiki Activity
76655 commits 19 branches 65 tags 4.2 GiB
Commit graph

94 commits

Author SHA1 Message Date
skyace65
94fc2efaa2 Fix spinbox formatting to fix linking 2025-07-23 06:58:16 -04:00
kobewi
13f642d959
Replace XML codeblock spaces with tabs 2025-06-06 14:35:38 +02:00
Haoyu Qiu
1ca5bc2d04 Doc: Add "required" qualifier to methods 2025-06-05 21:41:07 +08:00
Thaddeus Crews
2b1f463de5
SCons: Refactor color.py 2025-03-25 12:27:35 -05:00
tetrapod
75bb2c57ac Add parentheses to method links in online class reference 2025-02-07 15:36:25 -08:00
Thaddeus Crews
382c760ea6
SCons: Apply new ruff/mypy fixes 2025-02-03 09:55:09 -06:00
Thaddeus Crews
a29294fddc
SCons: Refactor color output implementation 2025-01-07 18:44:53 -06:00
Thaddeus Crews
d8761f2c79
SCons: Improve colored output 2024-12-10 11:44:48 -06:00
Danil Alexeev
ba943e4481
Adjust make_rst.py for GDScript documentation 2024-11-30 11:48:14 +03:00
Danil Alexeev
03b05cf9ac
Core: Fix built-in enum constant bindings 2024-11-22 14:03:21 +03:00
Rémi Verschelde
d5aadc38b4
Merge pull request #97337 from Ivorforce/patch-1 
In make_rst.py, include the parent class in 'Inherits:' even if it is not known.
 2024-09-23 12:34:19 +02:00
Lukas Tenbrink
21fb753bbd
Fix a typo in make_rst.py (Packedfloat64Array -> PackedFloat64Array) 2024-09-22 21:09:08 +02:00
Lukas Tenbrink
50ad99bdc0
In make_rst.py, include the parent class in 'Inherits:' even if it is not known. 2024-09-22 20:56:20 +02:00
Rémi Verschelde
0b4ae20156
Merge pull request #78656 from Repiteo/typed-dictionary 
Implement typed dictionaries
 2024-09-06 22:38:13 +02:00
Thaddeus Crews
9853a69144
Implement typed dictionaries 2024-09-04 10:27:26 -05:00
Danil Alexeev
2dd043d1f6
Docs: Add missing deprecated/experimental tag support for theme items 2024-09-04 17:49:05 +03:00
Ricardo Buring
b280bc0d7f Class reference: Add self-links to methods, properties, etc. 2024-05-26 09:54:17 +02:00
Jakub Marcowski
d9f8ef68df
Update pre-commit hooks configuration to use ruff instead of black 2024-05-21 18:02:29 -05:00
Thaddeus Crews
a9810cffb4
SCons: Fix potential Windows ANSI exception 2024-05-18 13:14:31 -05:00
K. S. Ernest (iFire) Lee
f9b488508c
Add PackedVector4Array Variant type 
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
 2024-05-03 00:58:27 +02:00
A Thousand Ships
23782b898b
Add further details on properties returning Packed*Array 2024-04-08 11:35:27 +02:00
Danil Alexeev
ca486985d5
Documentation: Fix RST generation for [codeblock lang=text] 2024-03-11 10:24:09 +03:00
Thaddeus Crews
fb299d0fb1
SCons: Ensure with statement where applicable 2024-03-10 12:57:57 -05:00
Thaddeus Crews
d9fa40f2df
Enforce \n eol for Python writes 
• Ensure utf-8 encoding if previously unspecified
 2024-03-09 14:29:24 -06:00
Danil Alexeev
87718d2a6e
Editor Help: Add syntax highlighting for code blocks 2024-03-09 00:02:31 +03:00
Abel Toy
882441a0ad
Support Array and PackedArray in @export_* 2024-03-06 16:17:54 +09:00
Danil Alexeev
8ed19d1a24
Make RST docs consistent with Editor Help docs 2024-02-19 20:03:27 +03:00
Danil Alexeev
12c86c6716
Documentation: Treat deprecated/experimental members as documented 2024-02-16 17:15:33 +03:00
Danil Alexeev
af28f87791
Documentation: Add support for deprecated/experimental messages 2024-02-15 15:59:50 +03:00
RedMser
db798b29b2 Add keywords to the class reference 
Allows for finding methods, properties, signals, constants,
theme items and annotations more easily.

- Allow "keywords" attribute in aforementioned locations
  in the class reference XMLs
- Extends doctool, to preserve these attributes
- Update the XSD schema for the class reference
- Update the RST generator to include a meta tag for class keywords
- Update the editor help to support filtering by keywords
 2024-02-09 18:13:23 +01:00
Micky
0b02b9571c Add "missing description" tag to constant documentation 
Revives #85836

Co-Authored-By: krysperz2 <106302189+krysperz2@users.noreply.github.com>
 2024-01-16 18:33:33 +01:00
Rémi Verschelde
079d58be9c
Merge pull request #86971 from YuriSizov/makerst-parity-check 
Add code sample language parity check to `make_rst.py`
 2024-01-16 15:07:40 +01:00
Hugo Locurcio
cd3078e45b
makerst: Suggest using [code skip-lint] to skip warnings if intended 2024-01-15 15:09:21 +01:00
Yuri Sizov
bba3c70722 Add code sample language parity check to make_rst.py 2024-01-15 14:38:04 +01:00
Micky
46b0f3e9d6 Fixing some reports to String's documentation 
Closes https://github.com/godotengine/godot-docs/issues/8043
Closes https://github.com/godotengine/godot-docs/issues/8044
Mitigates https://github.com/godotengine/godot-docs/issues/8190
Closes https://github.com/godotengine/godot/issues/86734
 2024-01-10 12:21:08 +01:00
Haoyu Qiu
9c83d3db5b Fix missing heading in translated online class reference 2023-12-07 11:35:06 +08:00
Mikael Klasson
4986d6d317 Fix invalid Python escape sequences 2023-12-06 11:51:41 +09:00
Hugo Locurcio
c7f6504105
makerst: Disallow user-contributed notes on the class index page 
User-contributed notes are still allowed on individual class pages.
 2023-11-17 10:51:29 +01:00
Yuri Sizov
0924ae0167 Resolve collisions in reference anchors added for methods 
While the anchors themselves were sufficiently unique,
when converted to HTML all underscore characters are
replaced. This created collisions between, say, Object._get and
Object.get, where the latter would get a generic unique
anchor identifier, e.g. id1.
 2023-11-08 15:16:35 +01:00
Yuri Sizov
cc0eebd9d8 Validate code tags for class and member references 
This commit also adds means to manually disable warnings
in `code` tags where it's a false positive with the new
`skip-lint` attribute.

Warnings are now enabled on CI to prevent future errors.
 2023-10-03 15:48:31 +02:00
Raul Santos
a164e3e7b3
Add a note about C# differences in classref doc 2023-07-09 01:44:48 +02:00
Rémi Verschelde
81064cc239
Doctool: Remove version attribute from XML header 
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).
 2023-07-06 10:08:21 +02:00
Rémi Verschelde
c9c941e339
CI: Update static checks to black 23.3.0 
And apply it to the codebase, removing empty lines at the start of blocks.
 2023-06-19 23:33:02 +02:00
Danil Alexeev
eb391d3302
Display BitField[Enum] in docs to distinguish from Enum 2023-06-15 17:23:02 +03:00
Yuri Sizov
391eccca76 Validate code tags in documentation for potential params 
Adds a check to make_rst to look for matches
between the text inside of the [code][/code] tag
and known param identifiers.
Fixes most of what was revealed.
 2023-04-26 21:36:04 +02:00
Yuri Sizov
0562decf34 Unexpose AnimationTrackEditPlugin as not implemented 2023-04-25 11:38:17 +02:00
Yuri Sizov
3ae282b452 Create an "Editor-only" section in the online class reference 
This helps to find such classes without digging
through the rest of the class reference.
Editor-only classes can still be found under
your normal "Node" and "Resource" types.

This also fixes a typo and a missed case from the recent platform docs PR.
 2023-04-24 21:06:55 +02:00
bruvzg
a5128e71bb
[Export docs] Move docs to platform folders. 2023-04-20 11:02:12 +03:00
Hana
026791027f fix conversion of csharp attributes in code blocks 2022-12-05 22:58:47 +01:00
Yuri Sizov
9e71cacd61 Improve layout of generated class references RST pages 
- General improvements to the page layout
- Improved formatting for all class (properties, signals, annotations, theme properties, methods, operators, constructors, enumerations, constants)
- Added extra styling opportunities throughout the generated document
- Made generated tables more flexible to their content
- Changed highlighting for self-reference from code to strong
 2022-12-05 15:30:09 +03:00