d9f8ef68df
Update pre-commit hooks configuration to use `ruff` instead of `black`
2024-05-21 18:02:29 -05:00
a9810cffb4
SCons: Fix potential Windows ANSI exception
2024-05-18 13:14:31 -05:00
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
23782b898b
Add further details on properties returning `Packed*Array`
2024-04-08 11:35:27 +02:00
ca486985d5
Documentation: Fix RST generation for `[codeblock lang=text]`
2024-03-11 10:24:09 +03:00
fb299d0fb1
SCons: Ensure `with` statement where applicable
2024-03-10 12:57:57 -05:00
d9fa40f2df
Enforce `\n` eol for Python writes
...
• Ensure utf-8 encoding if previously unspecified
2024-03-09 14:29:24 -06:00
87718d2a6e
Editor Help: Add syntax highlighting for code blocks
2024-03-09 00:02:31 +03:00
882441a0ad
Support Array and PackedArray in @export_*
2024-03-06 16:17:54 +09:00
8ed19d1a24
Make RST docs consistent with Editor Help docs
2024-02-19 20:03:27 +03:00
12c86c6716
Documentation: Treat deprecated/experimental members as documented
2024-02-16 17:15:33 +03:00
af28f87791
Documentation: Add support for deprecated/experimental messages
2024-02-15 15:59:50 +03:00
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
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
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
cd3078e45b
makerst: Suggest using `[code skip-lint]` to skip warnings if intended
2024-01-15 15:09:21 +01:00
bba3c70722
Add code sample language parity check to make_rst.py
2024-01-15 14:38:04 +01:00
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
9c83d3db5b
Fix missing heading in translated online class reference
2023-12-07 11:35:06 +08:00
4986d6d317
Fix invalid Python escape sequences
2023-12-06 11:51:41 +09:00
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
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
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
d087eb7faa
Merge pull request #79406 from Calinou/docstatus-fix-version
...
Fix `doc_status.py` trying to get removed `version` tag from XML
2023-07-14 18:50:04 +02:00
c16db0935f
Fix `doc_status.py` trying to get removed `version` tag from XML
...
This also runs `doc_status.py` on CI to catch potential future regressions.
2023-07-13 16:25:54 +02:00
a164e3e7b3
Add a note about C# differences in classref doc
2023-07-09 01:44:48 +02:00
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
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
eb391d3302
Display `BitField[Enum]` in docs to distinguish from `Enum`
2023-06-15 17:23:02 +03:00
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
0562decf34
Unexpose AnimationTrackEditPlugin as not implemented
2023-04-25 11:38:17 +02:00
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
a5128e71bb
[Export docs] Move docs to platform folders.
2023-04-20 11:02:12 +03:00
026791027f
fix conversion of csharp attributes in code blocks
2022-12-05 22:58:47 +01:00
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
0aba659891
Merge pull request #68848 from Piralein/fix-class-ref
...
Fix warnings in class ref
2022-11-22 20:27:15 +03:00
a5e5f1aa50
fix warnings in classref
2022-11-20 19:25:13 +01:00
aac01fbaf8
Improve class reference split, list variant types separately
2022-11-18 15:47:53 +03:00
4a5c179405
Split generated RST for class reference based on the base type
2022-11-18 00:36:09 +03:00
270c810343
Add more call-to-action notes when documentation is missing
2022-11-17 22:33:55 +03:00
c5bd2f9dce
ci: add Python static analysis check via mypy
2022-09-30 19:03:17 +07:00
7f30e81abe
Fix invalid literals in generated rst docs
...
Before this change, API docs that look like this:
…adding [param character]s to the right of the string.
would turn into rst files that look like this:
…adding ``character``s to the right of the string.
That reStructuredText is invalid and causes warnings when the docs repo
is built.
2022-09-12 15:51:39 -04:00
e430975b86
[doc] Use f-strings throughout make_rst.py
...
Based on discussion in #64230
2022-08-30 13:02:25 -04:00
a287276ef0
Make cross-link generation more reliable in RST documentation
2022-08-26 19:13:41 +03:00
03dc8c5d6f
Merge pull request #63635 from asmaloney/add-python-type-hints
...
Add Python PEP 484/526 type hints to doc/tools/doc_status.py
2022-08-18 13:02:53 +03:00
d953d9590b
Improve the `make_rst.py` parser for BBCode tags
2022-08-15 17:45:10 +03:00
c5d7115038
Rename the argument tag to param in XML documentation
2022-08-08 22:34:31 +03:00
35c1eae8d7
Add support for [param foo] syntax in valid documentation contexts
2022-08-08 22:18:38 +03:00
beceba85da
Add checks for empty/unnamed arguments to make_rst.py
2022-08-08 16:36:01 +03:00
2748220133
[make_rst] Remove (fake) return types on annotations
...
Based on discussion in #63561 , Yuri mentioned that the return types are not necessary here, so remove the fake "void" return types on annotations.
2022-08-04 20:10:32 -04:00
Jakub Marcowski
Thaddeus Crews
K. S. Ernest (iFire) Lee
A Thousand Ships
Danil Alexeev
Abel Toy
RedMser
Micky
Rémi Verschelde
Hugo Locurcio
Yuri Sizov
Haoyu Qiu
Mikael Klasson
Raul Santos
bruvzg
Hana
Yuri Sizov
Jiri Suchan
Jason Yundt
Andy Maloney