summaryrefslogtreecommitdiff
path: root/doc/tools
AgeCommit message (Collapse)Author
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" ```
2020-11-10doc: Fixups to #43419 which added operators in the docsRémi Verschelde
- 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-09-15makerst: Add missing newline at EOFRémi Verschelde
2020-07-31Merge pull request #40613 from HaSa1002/multi-lang-docsRémi Verschelde
Add multiple programming language support to class reference
2020-07-30makerst: Add descriptions to method qualifiersHugo Locurcio
This closes https://github.com/godotengine/godot-docs/issues/1753.
2020-07-23Add multiple programming language support to class referenceHaSa1002
2020-05-27makerst: Print status messages to make the CI output clearerHugo Locurcio
This also removes an unused method.
2020-04-29Merge pull request #36960 from pycbouh/docs-improve-shortcutsRémi Verschelde
Improve shortcut formatting in docs
2020-04-24doc: Fix parsing typed arrays in makerst.pyRémi Verschelde
`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-10Improve shortcut formatting in docsYuri Sizov
2020-04-10Merge pull request #37426 from pycbouh/docs-override-propertiesRémi Verschelde
Add more verbosity for property overrides in RST documentation
2020-03-31Fixed errors in makerst pre-commit hookPouleyKetchoupp
2020-03-30Add more verbosity for property overrides in RST documentationYuri Sizov
2020-03-30SCons: Format buildsystem files with psf/blackRémi Verschelde
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.
2020-02-01Improve the `doc_status.py` console outputHugo Locurcio
- 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.
2020-01-26doc: Drop unused 'category' property from headerRémi Verschelde
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.
2020-01-24Count theme items in doc_status.pyTomasz Chabora
2020-01-24makerst: Escape reST markup after enumsRémi Verschelde
Fixes #35501.
2020-01-20makerst: Use code markup for default values/overridesRémi Verschelde
Fixes godotengine/godot-docs#3071.
2020-01-15doc: Move the class description to be just below the brief descriptionHugo Locurcio
- 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.
2019-12-06Add a pre-commit hook to check the class reference syntaxHugo Locurcio
This also makes documentation helper scripts executable.
2019-12-04Travis CI: Run `makerst.py` to check for documentation errorsHugo Locurcio
2019-11-29makerst: Escape default values using reST markupRémi Verschelde
Otherwise the docs would complain about values like "godot_" which reST tries to interpret as an identifier.
2019-10-24makerst: Separate signals/enums/properties/methods with a lineHugo Locurcio
2019-10-08Fixed AttributeError on doc_status.pySamuelDeboni
2019-10-01Print errors when tab indent found in [codeblock]Yeongho Kim
2019-09-04Add overriden properties to the documentationBojidar Marinov
Fixes #31855
2019-07-25Adds a meta on top of every generated class to hide 'Edit on Github' linkStraToN
Linked docs issue https://github.com/godotengine/godot-docs/pull/2656
2019-06-27Add default values to the editor help, docs, and generated RSTBojidar Marinov
Also, make spacing of "=" in the editor help a bit more consistent. Closes #16086
2019-06-11makerst: Fix format of [url] links in reSTRémi Verschelde
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.
2019-05-16Add support for [url=] tag to makerst.pyStanislav
Fixes #28904
2019-04-19doc: Drop unused <demos> tagRémi Verschelde
2019-04-06Remove unused importsHendrikto
2019-03-29ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass]Ignacio Etcheverry
Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29EditorHelp, makerst: Improve enum ref resolving and constant ref supportIgnacio Etcheverry
Enum reference resolving will now search in the @GlobalScope if no class is specified and the enum cannot be resolved in the current class. Added support for constant references in EditorHelp, e.g.: [constant KEY_ENTER] or [constant Control.FOCUS_CLICK]. It supports enum constants (the enum name must not be included).
2019-03-10doc: Fix style for vararg in makerstRémi Verschelde
2019-03-05makerst: make vararg methods look the same as in editor helpmerumelu
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-16 17:31:08 +0000