| Age | Commit message (Collapse) | Author |
|---|
|
Fixup to #55092.
|
|
|
|
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>
|
|
|
|
|
|
As this requires more work to ensure that the refs are valid and unique.
|
|
Otherwise we get errors if we use the same title for different links in a given class.
|
|
|
|
* 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.
|
|
Way less cruft. :)
Co-authored-by: Ignacio Roldán Etcheverry <neikeq@users.noreply.github.com>
|
|
|
|
|
|
|
|
|
|
|
|
This only affects `Object` classes, not `Variant`.
|
|
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"
```
|
|
- 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`.
|
|
|
|
Add multiple programming language support to class reference
|
|
This closes https://github.com/godotengine/godot-docs/issues/1753.
|
|
|
|
This also removes an unused method.
|
|
Improve shortcut formatting in docs
|
|
`Type[]` typed arrays will link to `Type`, as it's likely the most
interesting information for the user.
And sync classref with current source.
|
|
|
|
Add more verbosity for property overrides in RST documentation
|
|
|
|
|
|
Configured for a max line length of 120 characters.
psf/black is very opinionated and purposely doesn't leave much room for
configuration. The output is mostly OK so that should be fine for us,
but some things worth noting:
- Manually wrapped strings will be reflowed, so by using a line length
of 120 for the sake of preserving readability for our long command
calls, it also means that some manually wrapped strings are back on
the same line and should be manually merged again.
- Code generators using string concatenation extensively look awful,
since black puts each operand on a single line. We need to refactor
these generators to use more pythonic string formatting, for which
many options are available (`%`, `format` or f-strings).
- CI checks and a pre-commit hook will be added to ensure that future
buildsystem changes are well-formatted.
|
|
- Duplicate the header when the `-a` flag is enabled. Since lots of
items are displayed in this case, this helps the user remember
which column is which without having to scroll back to the top.
- Bolden the overall percentages for easier visual grepping.
|
|
We already removed it from the online docs with #35132.
Currently it can only be "Built-In Types" (Variant types) or "Core"
(everything else), which is of limited use.
We might also want to consider dropping it from `ClassDB` altogether
in Godot 4.0.
|
|
|
|
Fixes #35501.
|
|
Fixes godotengine/godot-docs#3071.
|
|
- Drop the "Brief description" header as it became redundant
with this change.
- Fix a bug in the editor help where an extraneous newline was added
after the header if the class isn't inherited by any others.
- Remove the Category line in the rST markup as it's not useful
for API users.
|
|
This also makes documentation helper scripts executable.
|
|
|
|
Otherwise the docs would complain about values like "godot_"
which reST tries to interpret as an identifier.
|
|
|
|
|
|
|
|
Fixes #31855
|
|
Linked docs issue https://github.com/godotengine/godot-docs/pull/2656
|
|
Also, make spacing of "=" in the editor help a bit more consistent.
Closes #16086
|
|
Moved some logic to make_url in an attempt to reuse it in the parser,
but it proved too complex so I ended up not using it. I kept it as a
separate method nevertheless.
|
|
Fixes #28904
|
|
|
|
|
|
Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
|