summaryrefslogtreecommitdiff
path: root/doc/tools
AgeCommit message (Collapse)Author
2022-08-18Merge pull request #63635 from asmaloney/add-python-type-hintsYuri Sizov
Add Python PEP 484/526 type hints to doc/tools/doc_status.py
2022-08-15Improve the `make_rst.py` parser for BBCode tagsYuri Sizov
2022-08-08Rename the argument tag to param in XML documentationYuri Sizov
2022-08-08Add support for [param foo] syntax in valid documentation contextsYuri Sizov
2022-08-08Add checks for empty/unnamed arguments to make_rst.pyYuri Sizov
2022-08-04[make_rst] Remove (fake) return types on annotationsAndy Maloney
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-03Convert Python type hints in tools/make_rst.pyAndy Maloney
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.
2022-07-29Add Python PEP 484/526 type hints to doc/tools/doc_status.pyAndy Maloney
Also removes the first divider string which cleans up the extraneous dashes at the top of the page.
2022-07-28Patch the make_rst.py utility to handle specially operators with '<'Jcrespo
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.
2022-07-27doc: Fix relative paths in `make_rst.py` generated commentRémi Verschelde
Follow-up to #63495.
2022-07-27Merge pull request #63495 from YuriSizov/docs-improve-autogen-noteRémi Verschelde
2022-07-27Improve the autogenerated note in RST docs for class referenceYuri Sizov
2022-07-26Add missing Python type hints in tools/make_rst.pyAndy Maloney
2022-07-06Merge pull request #62713 from YuriSizov/docs-scripting-annotationsRémi Verschelde
2022-07-05Implement a BitField hintreduz
Allows to specify the binder that an enum must be treated as a bitfield.
2022-07-04Add support for documenting built-in annotationsYuri Sizov
2022-06-22makerst: Fix file name not appearing in error messageHugo Locurcio
2022-06-11Merge pull request #61920 from Calinou/makerst-print-colorRémi Verschelde
2022-06-11makerst: Print colored output for easier visual greppingHugo Locurcio
This is automatically enabled on all platforms including Windows 10 and later, whenever a TTY environment is detected. In non-TTY environments such as CI, this can be forced using the `--color` command line argument.
2022-06-10makerst: Fix duplicate `.xml` extension in some error messagesHugo Locurcio
Previously, a file name could appear as e.g. `ProjectSettings.xml.xml` when one of the 3 modified errors was reported.
2022-05-12Merge pull request #60771 from snailrhymer/enum-indentation-doc-fixRémi Verschelde
Indent bullet points in enum descriptions
2022-05-12Indent bullet points in enum descriptionsSnailRhymer
When converting doc xml files to rst, add an indenation level to bullet points in the text description of enum values. Also add check to avoid out of bounds error in rstize_text.
2022-05-11Implement exponential operator (**) to GDScript/ExpressionsYuri Roubinsky
2022-04-11makerst: Improve error reportingHugo Locurcio
- List file names before error descriptions, as is common in linters. - Print the number of errors reported at the end of the list. - Use double quotes instead of single quotes in messages.
2022-02-10Fix typos with codespellRémi Verschelde
Using codespell 2.2-dev from current git. Added `misc/scripts/codespell.sh` to make it easier to run it once in a while and update the skip and ignore lists.
2022-01-24Fix make_rst.py on WindowsMax Hilbrunner
2022-01-07Update doc_status script to support constructors and operators docsHugo Locurcio
- Reorder columns from highest number of items contained within to lowest number. - Remove some obsolete code and fix a typo.
2022-01-07Merge pull request #56162 from akien-mga/i18n-make_rst-more-translatableRémi Verschelde
i18n: Make more `make_rst.py` strings translatable
2022-01-06i18n: Make more `make_rst.py` strings translatableRémi Verschelde
For now we leave out the strings which could break rst table formatting.
2021-12-23Fix `make_rst.py` missing escape in front of some linksHaoyu Qiu
2021-12-21i18n: Add `--lang` option to `make_rst.py` to write translated headingsRémi Verschelde
Add a few missing headings to the translation templates.
2021-12-21Update `make_rst.py` for non-latin textsHaoyu Qiu
2021-12-03Make overridden properties link to parent definitionYuri Sizov
Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-11-19doc: Fix `make_rst.py` hyperlinks for theme itemsRémi Verschelde
Fixup to #55092.
2021-11-18Add [theme_item] tag to editor helpkobewi
2021-11-15Allow dehardcoding documentation branch and URL in docs linksRémi Verschelde
This makes it possible to change the branch of the documentation that URLs are pointing to without having to modify all class reference files. In the XML class reference, the `$DOCS_URL` placeholder should be used, and will be replaced automatically in the editor and when generating the RST class reference. The documentation branch string is set in `version.py`. Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2021-11-02Restore constructor/operator information in online docsYuri Sizov
2021-10-24Rename "makerst.py" to "make_rst.py"Aaron Franke
2021-10-05makerst: Disable making refs for operator methodsRémi Verschelde
As this requires more work to ensure that the refs are valid and unique.
2021-10-05makerst: Make external links anonymousRémi Verschelde
Otherwise we get errors if we use the same title for different links in a given class.
2021-10-05makerst: Add substitution for static qualifierRémi Verschelde
2021-08-23Implement NativeExtension pointer argumentsreduz
* Allows calling into native extensions directly with a pointer * Makes it easier to implement some APIs more efficiently * Appears with a "*" in the documentation for the argument. * Implementing the pointer handling is entirely up to the implementation, although the extension API provides some hint. * AudioStream has been implemented as an example, allowing to create NativeExtension based AudioStreams.
2021-08-17Remove underscore hacksMax Hilbrunner
Way less cruft. :) Co-authored-by: Ignacio Roldán Etcheverry <neikeq@users.noreply.github.com>
2021-08-06Fix minor code style issues in the RST generatorYuri Sizov
2021-08-04Add theme item descriptions to the online documentationYuri Sizov
2021-07-29makerst: use link titles for external tutorialsmerumelu
2021-07-12Makerst: Remove redundant GDScript from code blocksJohannes Witt
2021-07-09Make makerst.py create folders automatically, print a message when doneHugo Locurcio
2021-04-06makerst: Fix generation of overridden properties in child classesAndrii Doroshenko (Xrayez)
This only affects `Object` classes, not `Variant`.
2021-02-15makerst: Add an option to filter which XML classes to outputAndrii Doroshenko (Xrayez)
Usage: ``` # Output `VisualScript` classes only (found in `modules/visual_script`) python doc/tools/makerst.py "doc/classes" "modules" --filter "visual_script" # Output CSG classes only (found in `modules/csg`) python doc/tools/makerst.py "doc/classes" "modules" --filter "csg" ```