Commit Graph

115 Commits

Author SHA1 Message Date
51b251e889 Restore constructor/operator information in online docs 2021-11-02 22:33:55 +03:00
8f05e26198 Rename "makerst.py" to "make_rst.py" 2021-10-24 01:58:59 -05:00
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
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
e87f3dd4d0 makerst: Add substitution for static qualifier 2021-10-05 19:13:24 +02:00
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
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
1352a087b3 Fix minor code style issues in the RST generator 2021-08-06 18:18:22 +03:00
bf2839ea3e Add theme item descriptions to the online documentation 2021-08-04 22:27:10 +03:00
b8752d91dc makerst: use link titles for external tutorials 2021-07-29 21:55:39 +02:00
fa573efa1c Makerst: Remove redundant GDScript from code blocks 2021-07-12 12:57:31 +02:00
f05aa9cc01 Make makerst.py create folders automatically, print a message when done 2021-07-09 00:55:45 +02:00
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
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
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
d435537f7e makerst: Add missing newline at EOF 2020-09-15 10:47:35 +02:00
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
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
5b51ae1c5d Add multiple programming language support to class reference 2020-07-23 15:19:09 +02:00
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
41af228b76 Merge pull request #36960 from pycbouh/docs-improve-shortcuts
Improve shortcut formatting in docs
2020-04-29 09:40:52 +02:00
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
1ea7295bd2 Improve shortcut formatting in docs 2020-04-10 18:42:11 +03:00
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
619354fb2c Fixed errors in makerst pre-commit hook 2020-03-31 00:02:11 +02:00
38821dc6d7 Add more verbosity for property overrides in RST documentation 2020-03-30 14:18:43 +03:00
cd4e46ee65 SCons: Format buildsystem files with psf/black
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-03-30 09:05:53 +02:00
7c3f6b2870 Improve the doc_status.py console output
- 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-02-01 00:24:39 +01:00
2d20fc39aa doc: Drop unused 'category' property from header
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-26 16:02:39 +01:00
25ea912d96 Count theme items in doc_status.py 2020-01-24 14:23:58 +01:00
97cc2e53f6 makerst: Escape reST markup after enums
Fixes #35501.
2020-01-24 13:08:36 +01:00
c0595206dd makerst: Use code markup for default values/overrides
Fixes godotengine/godot-docs#3071.
2020-01-20 12:38:08 +01:00
3c8abbc4bf doc: Move the class description to be just below the brief description
- 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.
2020-01-15 00:05:34 +01:00
17add2dc86 Add a pre-commit hook to check the class reference syntax
This also makes documentation helper scripts executable.
2019-12-06 23:40:19 +01:00
bc4dbcf793 Travis CI: Run makerst.py to check for documentation errors 2019-12-04 08:51:32 +01:00
55676b16da makerst: Escape default values using reST markup
Otherwise the docs would complain about values like "godot_"
which reST tries to interpret as an identifier.
2019-11-29 14:25:37 +01:00
c2e5ef4cec makerst: Separate signals/enums/properties/methods with a line 2019-10-24 19:06:09 +02:00
35d22e414f Fixed AttributeError on doc_status.py 2019-10-08 11:29:59 -03:00
d4a55fb639 Print errors when tab indent found in [codeblock] 2019-10-01 23:39:45 +09:00
6c4407bae4 Add overriden properties to the documentation
Fixes #31855
2019-09-04 15:21:40 +03:00
d83b8881ae Adds a meta on top of every generated class to hide 'Edit on Github' link
Linked docs issue https://github.com/godotengine/godot-docs/pull/2656
2019-07-25 15:57:43 +02:00
0c4c36d823 Add default values to the editor help, docs, and generated RST
Also, make spacing of "=" in the editor help a bit more consistent.
Closes #16086
2019-06-27 18:29:35 +03:00
c7246d8e1e makerst: Fix format of [url] links in reST
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-06-11 10:51:10 +02:00
102f73b88a Add support for [url=] tag to makerst.py
Fixes #28904
2019-05-16 16:13:42 +03:00
6af69f851a doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
49a81308c0 Remove unused imports 2019-04-06 18:05:05 +02:00
d80bc5cbba ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass]
Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 23:47:35 +01:00
c8aa85189a EditorHelp, makerst: Improve enum ref resolving and constant ref support
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-29 23:40:31 +01:00
61771ad39b doc: Fix style for vararg in makerst 2019-03-10 11:31:27 +01:00
4d9b7b9803 makerst: make vararg methods look the same as in editor help 2019-03-05 20:42:09 +01:00