godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
44,995 Commits 15 Branches 59 Tags 2.2 GiB
f3561696da
Commit Graph

139 Commits

Author SHA1 Message Date
Yuri Sizov
f3561696da Improve the autogenerated note in RST docs for class reference 2022-07-27 13:43:06 +03:00
Rémi Verschelde
635d447a69
Merge pull request #62713 from YuriSizov/docs-scripting-annotations 2022-07-06 15:31:19 +02:00
reduz
5ac42cf576 Implement a BitField hint 
Allows to specify the binder that an enum must be treated as a bitfield.
 2022-07-05 22:13:37 +02:00
Yuri Sizov
a9098e6147 Add support for documenting built-in annotations 2022-07-04 20:21:39 +03:00
Hugo Locurcio
49f94b94c7
makerst: Fix file name not appearing in error message 2022-06-22 12:17:15 +02:00
Rémi Verschelde
126e4d0a5b
Merge pull request #61920 from Calinou/makerst-print-color 2022-06-11 11:42:18 +02:00
Hugo Locurcio
d45351f413
makerst: Print colored output for easier visual grepping 
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-11 00:19:36 +02:00
Hugo Locurcio
1163af1756
makerst: Fix duplicate .xml extension in some error messages 
Previously, a file name could appear as e.g. `ProjectSettings.xml.xml`
when one of the 3 modified errors was reported.
 2022-06-10 22:58:09 +02:00
Rémi Verschelde
826f5358a1
Merge pull request #60771 from snailrhymer/enum-indentation-doc-fix 
Indent bullet points in enum descriptions
 2022-05-12 21:13:21 +02:00
SnailRhymer
38cf07b768 Indent bullet points in enum descriptions 
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-12 19:34:49 +01:00
Yuri Roubinsky
dbd7a31507 Implement exponential operator (**) to GDScript/Expressions 2022-05-11 16:30:37 +03:00
Hugo Locurcio
f0b860fbad
makerst: Improve error reporting 
- 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-04-11 02:34:37 +02:00
Rémi Verschelde
1bdb82c64e
Fix typos with codespell 
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-02-10 12:30:19 +01:00
Max Hilbrunner
26da72eb4b Fix make_rst.py on Windows 2022-01-24 10:30:07 +01:00
Hugo Locurcio
1b01cef301
Update doc_status script to support constructors and operators docs 
- Reorder columns from highest number of items contained within
  to lowest number.
- Remove some obsolete code and fix a typo.
 2022-01-07 23:50:10 +01:00
Rémi Verschelde
0905f81c0a
Merge pull request #56162 from akien-mga/i18n-make_rst-more-translatable 
i18n: Make more `make_rst.py` strings translatable
 2022-01-07 09:23:57 +01:00
Rémi Verschelde
fd1d0c28c2
i18n: Make more make_rst.py strings translatable 
For now we leave out the strings which could break rst table formatting.
 2022-01-06 21:13:38 +01:00
Haoyu Qiu
a07e2b71fc Fix make_rst.py missing escape in front of some links 2021-12-23 00:50:40 +08:00
Rémi Verschelde
b98785309f
i18n: Add --lang option to make_rst.py to write translated headings 
Add a few missing headings to the translation templates.
 2021-12-21 13:47:11 +01:00
Haoyu Qiu
9844e36354 Update make_rst.py for non-latin texts 2021-12-21 16:35:47 +08:00
Yuri Sizov
b3992f7e6e Make overridden properties link to parent definition 
Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
 2021-12-03 17:47:22 +03:00
Rémi Verschelde
1a9e3d581b
doc: Fix make_rst.py hyperlinks for theme items 
Fixup to #55092.
 2021-11-19 10:41:17 +01:00
kobewi
6f929395d9 Add [theme_item] tag to editor help 2021-11-18 15:32:23 +01:00
Rémi Verschelde
5341e6010e
Allow dehardcoding documentation branch and URL in docs links 
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-15 13:02:21 +01:00
Yuri Sizov
51b251e889 Restore constructor/operator information in online docs 2021-11-02 22:33:55 +03:00
Aaron Franke
8f05e26198
Rename "makerst.py" to "make_rst.py" 2021-10-24 01:58:59 -05:00
Rémi Verschelde
20b56f557c
makerst: Disable making refs for operator methods 
As this requires more work to ensure that the refs are valid and unique.
 2021-10-05 19:13:24 +02:00
Rémi Verschelde
1e36f5f524
makerst: Make external links anonymous 
Otherwise we get errors if we use the same title for different links in a given class.
 2021-10-05 19:13:24 +02:00
Rémi Verschelde
e87f3dd4d0
makerst: Add substitution for static qualifier 2021-10-05 19:13:24 +02:00
reduz
44d62a9f4b Implement NativeExtension pointer arguments 
* 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-23 19:58:40 -03:00
Max Hilbrunner
5161c97c9c Remove underscore hacks 
Way less cruft. :)

Co-authored-by: Ignacio Roldán Etcheverry <neikeq@users.noreply.github.com>
 2021-08-17 16:10:28 +02:00
Yuri Sizov
1352a087b3 Fix minor code style issues in the RST generator 2021-08-06 18:18:22 +03:00
Yuri Sizov
bf2839ea3e Add theme item descriptions to the online documentation 2021-08-04 22:27:10 +03:00
merumelu
b8752d91dc makerst: use link titles for external tutorials 2021-07-29 21:55:39 +02:00
Johannes Witt
fa573efa1c
Makerst: Remove redundant GDScript from code blocks 2021-07-12 12:57:31 +02:00
Hugo Locurcio
f05aa9cc01
Make makerst.py create folders automatically, print a message when done 2021-07-09 00:55:45 +02:00
Andrii Doroshenko (Xrayez)
679d038043 makerst: Fix generation of overridden properties in child classes 
This only affects `Object` classes, not `Variant`.
 2021-04-06 17:26:18 +03:00
Andrii Doroshenko (Xrayez)
7fcdd15f0c makerst: Add an option to filter which XML classes to output 
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"
```
 2021-02-15 14:28:11 +02:00
Rémi Verschelde
34cad0d020
doc: Fixups to #43419 which added operators in the docs 
- Escape the method names as e.g. `operator <` is invalid XML.
- Add a hack to merge all String % operator definitions for each Variant type
  as a single one with `Variant` argument type.
- Add support for the new qualifiers in makerst.py.
- Drop unused `doc_merge.py`, seems to date back to when we had all the
  documentation in a single `classes.xml`.
 2020-11-10 15:00:07 +01:00
Rémi Verschelde
d435537f7e
makerst: Add missing newline at EOF 2020-09-15 10:47:35 +02:00
Rémi Verschelde
5d880bf7db
Merge pull request #40613 from HaSa1002/multi-lang-docs 
Add multiple programming language support to class reference
 2020-07-31 14:51:33 +02:00
Hugo Locurcio
c162a39c7b
makerst: Add descriptions to method qualifiers 
This closes https://github.com/godotengine/godot-docs/issues/1753.
 2020-07-30 22:11:02 +02:00
HaSa1002
5b51ae1c5d Add multiple programming language support to class reference 2020-07-23 15:19:09 +02:00
Hugo Locurcio
9065b7ed4e
makerst: Print status messages to make the CI output clearer 
This also removes an unused method.
 2020-05-27 22:24:33 +02:00
Rémi Verschelde
41af228b76
Merge pull request #36960 from pycbouh/docs-improve-shortcuts 
Improve shortcut formatting in docs
 2020-04-29 09:40:52 +02:00
Rémi Verschelde
d567c15aed doc: Fix parsing typed arrays in makerst.py 
`Type[]` typed arrays will link to `Type`, as it's likely the most
interesting information for the user.

And sync classref with current source.
 2020-04-24 17:50:20 +02:00
Yuri Sizov
1ea7295bd2 Improve shortcut formatting in docs 2020-04-10 18:42:11 +03:00
Rémi Verschelde
f33bba15b1
Merge pull request #37426 from pycbouh/docs-override-properties 
Add more verbosity for property overrides in RST documentation
 2020-04-10 12:25:47 +02:00
PouleyKetchoupp
619354fb2c Fixed errors in makerst pre-commit hook 2020-03-31 00:02:11 +02:00
Yuri Sizov
38821dc6d7 Add more verbosity for property overrides in RST documentation 2020-03-30 14:18:43 +03:00