Commit message (Collapse) | Author | Age | Files | Lines | |
---|---|---|---|---|---|
* | Add further details on properties returning `Packed*Array` | A Thousand Ships | 2024-04-08 | 1 | -0/+16 |
| | |||||
* | Documentation: Fix RST generation for `[codeblock lang=text]` | Danil Alexeev | 2024-03-11 | 1 | -1/+1 |
| | |||||
* | SCons: Ensure `with` statement where applicable | Thaddeus Crews | 2024-03-10 | 1 | -439/+439 |
| | |||||
* | Enforce `\n` eol for Python writes | Thaddeus Crews | 2024-03-09 | 1 | -4/+4 |
| | | | | • Ensure utf-8 encoding if previously unspecified | ||||
* | Editor Help: Add syntax highlighting for code blocks | Danil Alexeev | 2024-03-09 | 1 | -17/+25 |
| | |||||
* | Support Array and PackedArray in @export_* | Abel Toy | 2024-03-06 | 1 | -1/+7 |
| | |||||
* | Make RST docs consistent with Editor Help docs | Danil Alexeev | 2024-02-19 | 1 | -16/+31 |
| | |||||
* | Documentation: Treat deprecated/experimental members as documented | Danil Alexeev | 2024-02-16 | 1 | -8/+8 |
| | |||||
* | Documentation: Add support for deprecated/experimental messages | Danil Alexeev | 2024-02-15 | 1 | -5/+71 |
| | |||||
* | Add keywords to the class reference | RedMser | 2024-02-09 | 1 | -0/+9 |
| | | | | | | | | | | | | 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 | ||||
* | Add "missing description" tag to constant documentation | Micky | 2024-01-16 | 1 | -0/+18 |
| | | | | | | Revives #85836 Co-Authored-By: krysperz2 <106302189+krysperz2@users.noreply.github.com> | ||||
* | Merge pull request #86971 from YuriSizov/makerst-parity-check | Rémi Verschelde | 2024-01-16 | 1 | -47/+122 |
|\ | | | | | | | Add code sample language parity check to `make_rst.py` | ||||
| * | Add code sample language parity check to make_rst.py | Yuri Sizov | 2024-01-15 | 1 | -47/+122 |
| | | |||||
* | | makerst: Suggest using `[code skip-lint]` to skip warnings if intended | Hugo Locurcio | 2024-01-15 | 1 | -12/+13 |
|/ | |||||
* | Fixing some reports to String's documentation | Micky | 2024-01-10 | 1 | -0/+1 |
| | | | | | | | 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 | ||||
* | Fix missing heading in translated online class reference | Haoyu Qiu | 2023-12-07 | 1 | -7/+2 |
| | |||||
* | Fix invalid Python escape sequences | Mikael Klasson | 2023-12-06 | 1 | -9/+9 |
| | |||||
* | makerst: Disallow user-contributed notes on the class index page | Hugo Locurcio | 2023-11-17 | 1 | -2/+3 |
| | | | | User-contributed notes are still allowed on individual class pages. | ||||
* | Resolve collisions in reference anchors added for methods | Yuri Sizov | 2023-11-08 | 1 | -14/+28 |
| | | | | | | | | 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. | ||||
* | Validate `code` tags for class and member references | Yuri Sizov | 2023-10-03 | 1 | -134/+276 |
| | | | | | | | | 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. | ||||
* | Add a note about C# differences in classref doc | Raul Santos | 2023-07-09 | 1 | -0/+48 |
| | |||||
* | Doctool: Remove version attribute from XML header | Rémi Verschelde | 2023-07-06 | 1 | -4/+0 |
| | | | | | | 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). | ||||
* | CI: Update static checks to black 23.3.0 | Rémi Verschelde | 2023-06-19 | 1 | -1/+0 |
| | | | | And apply it to the codebase, removing empty lines at the start of blocks. | ||||
* | Display `BitField[Enum]` in docs to distinguish from `Enum` | Danil Alexeev | 2023-06-15 | 1 | -7/+16 |
| | |||||
* | Validate code tags in documentation for potential params | Yuri Sizov | 2023-04-26 | 1 | -0/+20 |
| | | | | | | | 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. | ||||
* | Unexpose AnimationTrackEditPlugin as not implemented | Yuri Sizov | 2023-04-25 | 1 | -1/+0 |
| | |||||
* | Create an "Editor-only" section in the online class reference | Yuri Sizov | 2023-04-24 | 1 | -0/+30 |
| | | | | | | | | | 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. | ||||
* | [Export docs] Move docs to platform folders. | bruvzg | 2023-04-20 | 1 | -1/+1 |
| | |||||
* | fix conversion of csharp attributes in code blocks | Hana | 2022-12-05 | 1 | -1/+1 |
| | |||||
* | Improve layout of generated class references RST pages | Yuri Sizov | 2022-12-05 | 1 | -83/+236 |
| | | | | | | | | - 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 | ||||
* | Merge pull request #68848 from Piralein/fix-class-ref | Yuri Sizov | 2022-11-22 | 1 | -7/+9 |
|\ | | | | | Fix warnings in class ref | ||||
| * | fix warnings in classref | Hana | 2022-11-20 | 1 | -7/+9 |
| | | |||||
* | | Improve class reference split, list variant types separately | Yuri Sizov | 2022-11-18 | 1 | -5/+23 |
|/ | |||||
* | Split generated RST for class reference based on the base type | Yuri Sizov | 2022-11-18 | 1 | -5/+99 |
| | |||||
* | Add more call-to-action notes when documentation is missing | Yuri Sizov | 2022-11-17 | 1 | -1/+64 |
| | |||||
* | ci: add Python static analysis check via mypy | Jiri Suchan | 2022-09-30 | 1 | -17/+12 |
| | |||||
* | Fix invalid literals in generated rst docs | Jason Yundt | 2022-09-12 | 1 | -0/+2 |
| | | | | | | | | | | | | | 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. | ||||
* | [doc] Use f-strings throughout make_rst.py | Andy Maloney | 2022-08-30 | 1 | -207/+154 |
| | | | | Based on discussion in #64230 | ||||
* | Make cross-link generation more reliable in RST documentation | Yuri Sizov | 2022-08-26 | 1 | -61/+60 |
| | |||||
* | Improve the `make_rst.py` parser for BBCode tags | Yuri Sizov | 2022-08-15 | 1 | -458/+633 |
| | |||||
* | Rename the argument tag to param in XML documentation | Yuri Sizov | 2022-08-08 | 1 | -7/+7 |
| | |||||
* | Add support for [param foo] syntax in valid documentation contexts | Yuri Sizov | 2022-08-08 | 1 | -14/+91 |
| | |||||
* | Add checks for empty/unnamed arguments to make_rst.py | Yuri Sizov | 2022-08-08 | 1 | -21/+32 |
| | |||||
* | [make_rst] Remove (fake) return types on annotations | Andy Maloney | 2022-08-04 | 1 | -19/+37 |
| | | | | Based on discussion in #63561, Yuri mentioned that the return types are not necessary here, so remove the fake "void" return types on annotations. | ||||
* | Convert Python type hints in tools/make_rst.py | Andy Maloney | 2022-08-03 | 1 | -162/+170 |
| | | | | Since Python 3.5+ is required, we can use proper type hints based on PEP 484. Because we are working on contributor tooling we can assume 3.6+ and use PEP 526 for variable declarations as well. | ||||
* | Patch the make_rst.py utility to handle specially operators with '<' | Jcrespo | 2022-07-28 | 1 | -1/+1 |
| | | | | | | | | | | | | | | | | | | | | | | | When generating rst files from xml class reference, unknown references to operators were generated, as something like: :ref:`operator <<class_Vector2_operator_lt_bool>` was rendered in html as: operator ( Vector2 right ) -it just needed escaping. The small addendum checks for operator names containing '<' and substitutes it with '\<', escaping at rst level and generating instead the right rendered html: operator < ( Vector2 right ) This affected mostly the reference pages of the VectorX family of classes. If in the future more types need escaping, a more general solution will be needed. | ||||
* | doc: Fix relative paths in `make_rst.py` generated comment | Rémi Verschelde | 2022-07-27 | 1 | -3/+3 |
| | | | | Follow-up to #63495. | ||||
* | Merge pull request #63495 from YuriSizov/docs-improve-autogen-note | Rémi Verschelde | 2022-07-27 | 1 | -4/+23 |
|\ | |||||
| * | Improve the autogenerated note in RST docs for class reference | Yuri Sizov | 2022-07-27 | 1 | -4/+23 |
| | | |||||
* | | Add missing Python type hints in tools/make_rst.py | Andy Maloney | 2022-07-26 | 1 | -2/+2 |
|/ |