summaryrefslogtreecommitdiffstats
path: root/doc/tools
Commit message (Collapse)AuthorAgeFilesLines
* [4.3] Rebranding: editor/ + doc/Dubhghlas McLaughlin2024-10-231-2/+2
|
* Rebrand Godot 4.3 to RedotTrashguy2024-10-131-4/+4
|
* Class reference: Add self-links to methods, properties, etc.Ricardo Buring2024-05-261-22/+46
|
* Update pre-commit hooks configuration to use `ruff` instead of `black`Jakub Marcowski2024-05-212-10/+9
|
* SCons: Fix potential Windows ANSI exceptionThaddeus Crews2024-05-181-12/+19
|
* Add PackedVector4Array Variant typeK. S. Ernest (iFire) Lee2024-05-031-0/+2
| | | | | Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com> Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
* Add further details on properties returning `Packed*Array`A Thousand Ships2024-04-081-0/+16
|
* Documentation: Fix RST generation for `[codeblock lang=text]`Danil Alexeev2024-03-111-1/+1
|
* SCons: Ensure `with` statement where applicableThaddeus Crews2024-03-101-439/+439
|
* Enforce `\n` eol for Python writesThaddeus Crews2024-03-091-4/+4
| | | | • Ensure utf-8 encoding if previously unspecified
* Editor Help: Add syntax highlighting for code blocksDanil Alexeev2024-03-091-17/+25
|
* Support Array and PackedArray in @export_*Abel Toy2024-03-061-1/+7
|
* Make RST docs consistent with Editor Help docsDanil Alexeev2024-02-191-16/+31
|
* Documentation: Treat deprecated/experimental members as documentedDanil Alexeev2024-02-162-11/+16
|
* Documentation: Add support for deprecated/experimental messagesDanil Alexeev2024-02-151-5/+71
|
* Add keywords to the class referenceRedMser2024-02-091-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 documentationMicky2024-01-161-0/+18
| | | | | | Revives #85836 Co-Authored-By: krysperz2 <106302189+krysperz2@users.noreply.github.com>
* Merge pull request #86971 from YuriSizov/makerst-parity-checkRémi Verschelde2024-01-161-47/+122
|\ | | | | | | Add code sample language parity check to `make_rst.py`
| * Add code sample language parity check to make_rst.pyYuri Sizov2024-01-151-47/+122
| |
* | makerst: Suggest using `[code skip-lint]` to skip warnings if intendedHugo Locurcio2024-01-151-12/+13
|/
* Fixing some reports to String's documentationMicky2024-01-101-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 referenceHaoyu Qiu2023-12-071-7/+2
|
* Fix invalid Python escape sequencesMikael Klasson2023-12-061-9/+9
|
* makerst: Disallow user-contributed notes on the class index pageHugo Locurcio2023-11-171-2/+3
| | | | User-contributed notes are still allowed on individual class pages.
* Resolve collisions in reference anchors added for methodsYuri Sizov2023-11-081-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 referencesYuri Sizov2023-10-031-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.
* Merge pull request #79406 from Calinou/docstatus-fix-versionYuri Sizov2023-07-141-6/+0
|\ | | | | | | Fix `doc_status.py` trying to get removed `version` tag from XML
| * Fix `doc_status.py` trying to get removed `version` tag from XMLHugo Locurcio2023-07-131-6/+0
| | | | | | | | This also runs `doc_status.py` on CI to catch potential future regressions.
* | Add a note about C# differences in classref docRaul Santos2023-07-091-0/+48
|/
* Doctool: Remove version attribute from XML headerRémi Verschelde2023-07-061-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.0Rémi Verschelde2023-06-191-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 Alexeev2023-06-151-7/+16
|
* Validate code tags in documentation for potential paramsYuri Sizov2023-04-261-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 implementedYuri Sizov2023-04-251-1/+0
|
* Create an "Editor-only" section in the online class referenceYuri Sizov2023-04-241-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.bruvzg2023-04-201-1/+1
|
* fix conversion of csharp attributes in code blocksHana2022-12-051-1/+1
|
* Improve layout of generated class references RST pagesYuri Sizov2022-12-051-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-refYuri Sizov2022-11-221-7/+9
|\ | | | | Fix warnings in class ref
| * fix warnings in classrefHana2022-11-201-7/+9
| |
* | Improve class reference split, list variant types separatelyYuri Sizov2022-11-181-5/+23
|/
* Split generated RST for class reference based on the base typeYuri Sizov2022-11-181-5/+99
|
* Add more call-to-action notes when documentation is missingYuri Sizov2022-11-171-1/+64
|
* ci: add Python static analysis check via mypyJiri Suchan2022-09-301-17/+12
|
* Fix invalid literals in generated rst docsJason Yundt2022-09-121-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.pyAndy Maloney2022-08-301-207/+154
| | | | Based on discussion in #64230
* Make cross-link generation more reliable in RST documentationYuri Sizov2022-08-261-61/+60
|
* Merge pull request #63635 from asmaloney/add-python-type-hintsYuri Sizov2022-08-181-34/+35
|\ | | | | Add Python PEP 484/526 type hints to doc/tools/doc_status.py
| * Add Python PEP 484/526 type hints to doc/tools/doc_status.pyAndy Maloney2022-07-291-34/+35
| | | | | | | | Also removes the first divider string which cleans up the extraneous dashes at the top of the page.
* | Improve the `make_rst.py` parser for BBCode tagsYuri Sizov2022-08-151-458/+633
| |