summaryrefslogtreecommitdiffstats
path: root/doc/tools/makerst.py
Commit message (Collapse)AuthorAgeFilesLines
* Rename "makerst.py" to "make_rst.py"Aaron Franke2021-10-241-1141/+0
|
* makerst: Disable making refs for operator methodsRémi Verschelde2021-10-051-0/+5
| | | | As this requires more work to ensure that the refs are valid and unique.
* makerst: Make external links anonymousRémi Verschelde2021-10-051-3/+3
| | | | Otherwise we get errors if we use the same title for different links in a given class.
* makerst: Add substitution for static qualifierRémi Verschelde2021-10-051-0/+1
|
* Implement NativeExtension pointer argumentsreduz2021-08-231-0/+2
| | | | | | | | * 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.
* Remove underscore hacksMax Hilbrunner2021-08-171-3/+0
| | | | | | Way less cruft. :) Co-authored-by: Ignacio Roldán Etcheverry <neikeq@users.noreply.github.com>
* Fix minor code style issues in the RST generatorYuri Sizov2021-08-061-1/+2
|
* Add theme item descriptions to the online documentationYuri Sizov2021-08-041-10/+56
|
* makerst: use link titles for external tutorialsmerumelu2021-07-291-8/+10
|
* Makerst: Remove redundant GDScript from code blocksJohannes Witt2021-07-121-1/+1
|
* Make makerst.py create folders automatically, print a message when doneHugo Locurcio2021-07-091-0/+5
|
* makerst: Fix generation of overridden properties in child classesAndrii Doroshenko (Xrayez)2021-04-061-1/+1
| | | | This only affects `Object` classes, not `Variant`.
* makerst: Add an option to filter which XML classes to outputAndrii Doroshenko (Xrayez)2021-02-151-3/+12
| | | | | | | | | | | 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" ```
* doc: Fixups to #43419 which added operators in the docsRémi Verschelde2020-11-101-0/+2
| | | | | | | | | - 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`.
* makerst: Add missing newline at EOFRémi Verschelde2020-09-151-1/+1
|
* Merge pull request #40613 from HaSa1002/multi-lang-docsRémi Verschelde2020-07-311-37/+62
|\ | | | | Add multiple programming language support to class reference
| * Add multiple programming language support to class referenceHaSa10022020-07-231-37/+62
| |
* | makerst: Add descriptions to method qualifiersHugo Locurcio2020-07-301-1/+18
|/ | | | This closes https://github.com/godotengine/godot-docs/issues/1753.
* makerst: Print status messages to make the CI output clearerHugo Locurcio2020-05-271-66/+6
| | | | This also removes an unused method.
* Merge pull request #36960 from pycbouh/docs-improve-shortcutsRémi Verschelde2020-04-291-0/+6
|\ | | | | Improve shortcut formatting in docs
| * Improve shortcut formatting in docsYuri Sizov2020-04-101-0/+6
| |
* | doc: Fix parsing typed arrays in makerst.pyRémi Verschelde2020-04-241-5/+8
|/ | | | | | | `Type[]` typed arrays will link to `Type`, as it's likely the most interesting information for the user. And sync classref with current source.
* Merge pull request #37426 from pycbouh/docs-override-propertiesRémi Verschelde2020-04-101-1/+1
|\ | | | | Add more verbosity for property overrides in RST documentation
| * Add more verbosity for property overrides in RST documentationYuri Sizov2020-03-301-1/+1
| |
* | Fixed errors in makerst pre-commit hookPouleyKetchoupp2020-03-311-1/+1
| |
* | SCons: Format buildsystem files with psf/blackRémi Verschelde2020-03-301-143/+172
|/ | | | | | | | | | | | | | | | | | | | | 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.
* doc: Drop unused 'category' property from headerRémi Verschelde2020-01-261-5/+0
| | | | | | | | | | 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.
* makerst: Escape reST markup after enumsRémi Verschelde2020-01-241-0/+1
| | | | Fixes #35501.
* makerst: Use code markup for default values/overridesRémi Verschelde2020-01-201-1/+1
| | | | Fixes godotengine/godot-docs#3071.
* doc: Move the class description to be just below the brief descriptionHugo Locurcio2020-01-151-17/+12
| | | | | | | | | - 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.
* Travis CI: Run `makerst.py` to check for documentation errorsHugo Locurcio2019-12-041-2/+6
|
* makerst: Escape default values using reST markupRémi Verschelde2019-11-291-30/+37
| | | | | Otherwise the docs would complain about values like "godot_" which reST tries to interpret as an identifier.
* makerst: Separate signals/enums/properties/methods with a lineHugo Locurcio2019-10-241-15/+38
|
* Print errors when tab indent found in [codeblock]Yeongho Kim2019-10-011-0/+5
|
* Add overriden properties to the documentationBojidar Marinov2019-09-041-6/+14
| | | | Fixes #31855
* Adds a meta on top of every generated class to hide 'Edit on Github' linkStraToN2019-07-251-0/+1
| | | | Linked docs issue https://github.com/godotengine/godot-docs/pull/2656
* Add default values to the editor help, docs, and generated RSTBojidar Marinov2019-06-271-39/+46
| | | | | Also, make spacing of "=" in the editor help a bit more consistent. Closes #16086
* makerst: Fix format of [url] links in reSTRémi Verschelde2019-06-111-21/+26
| | | | | | 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.
* Add support for [url=] tag to makerst.pyStanislav2019-05-161-2/+13
| | | | Fixes #28904
* Remove unused importsHendrikto2019-04-061-2/+1
|
* ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass]Ignacio Etcheverry2019-03-291-1/+5
| | | | Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
* EditorHelp, makerst: Improve enum ref resolving and constant ref supportIgnacio Etcheverry2019-03-291-7/+21
| | | | | 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).
* doc: Fix style for vararg in makerstRémi Verschelde2019-03-101-1/+1
|
* makerst: make vararg methods look the same as in editor helpmerumelu2019-03-051-0/+6
|
* makerst.py refactor.Pieter-Jan Briers2018-12-281-353/+601
| | | | | | | | | | | | | | | It's now smart and keeps track of every entity in the doc files. Now it can pick up on broken references and such inside the doc files. Eventually we'll be able to run it on Travis and check for errors automatically. General file cleanup. References to elements of classes now have a prefix for their type. class_Control_minimum_size_changed becomes class_Control_method_minimum_size_changed, or signal_, because the reason I did this was to fix reference conflicts. You can also reference constants now with BBCode. Also made it use argparse, adding an --output and a --dry-run argument. I did not fix all the errors it's reporting in the documentation files, there's about 150+ of them but that's outside of the scope of this commit.
* Clean up & improve makerst.pyPieter-Jan Briers2018-12-271-171/+169
| | | | | | | | | | | | | | Man this file even had some semicolons in it. I cleaned up the entire file, while it's still pretty ugly it's much better now. I also added type checks so it passes mypy --strict. make_type now throws a warning on unresolved type references, which there are a bunch of. I'm not responsible for fixing those though. Also some more hardening against crashes. For example XML tags without content won't cause crashes now. Functionality has not been modified as far as I can tell. Update Makefile for Python 3 Fix ordering issues related to enums & constants
* Enabled rst files to escape for parentheses after bracketsJoão Álvaro Ferreira2018-12-111-1/+1
|
* Dont use equality operators with None singleton in python fileslupoDharkael2018-10-271-4/+4
|
* Add extra newline after enum members and constants, to ensure they'll format ↵LikeLakers22018-10-021-4/+2
| | | | properly after a multi-line description
* doc: Fixes to rst converterRémi Verschelde2018-09-211-7/+8
|