summaryrefslogtreecommitdiffstats
path: root/doc/tools/makerst.py
Commit message (Collapse)AuthorAgeFilesLines
* 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
|
* Fix the weird method linking issue when the previous method's description ↵LikeLakers22018-09-201-1/+1
| | | | ends with a code block
* doc: Make property sections in rst similar to editor docsRémi Verschelde2018-09-131-69/+98
| | | | | | | | | There is now an overview table with hyperlinks, and further down a detailed list of properties with their setter/getter and description. Theme items are now also included in the rst output. Refactored make_method() a bit.
* Doc: Use PascalCase names in hyperlinksRémi Verschelde2018-09-131-2/+2
| | | | | | We were not consistently applying .lower() every time we construct an hyperlink, so there would be case mismatch. It works fine to keep the natural case for those links.
* Doc: Use same headers and order in-editor and onlineRémi Verschelde2018-09-121-38/+57
|
* Add support for tutorial links to makerst.pyrobojumper2018-06-121-0/+30
| | | | Also change the <tutorials> structure to make use of individual <link> tags
* makerst.py: Properly escape \ for rstRémi Verschelde2018-05-311-1/+11
| | | | Fixes godotengine/godot-docs#1486.
* Makes doc methods display enums.Pieter-Jan Briers2018-05-121-9/+28
|
* Properly closing all files in Python codeViktor Ferenczi2018-03-111-0/+3
|
* Documentation tool does not add escapes to code and codeblocksAnish2018-02-161-4/+26
| | | | | | | Instead of adding the escapes to all * and _ the tool now excludes the characters inside [code] and [codeblock]. Resolves: #15156
* Enums get listed in the docs and enum members now also link to theJoachim Meyer2017-12-221-2/+43
| | | | | corresponding enum in the webdocs Fixes #13254
* Fix the class docs for the rst-syntax errors.Martin Capitanio2017-11-191-0/+1
| | | | | | | | | | | | | | | | | | | | | | | - Generate a correkt rst-syntax for the [/code] inline markup. (http://www.sphinx-doc.org/en/1.6.5/rest.html#inline-markup) - Fix xml souce bugs for the sphinx's rst syntax werrors: class_area.rst:319: WARNING: Inline literal start-string without end-string. class_area2d.rst:287: WARNING: Inline literal start-string without end-string. class_audioserver.rst:287: WARNING: Inline literal start-string without end-string. class_control.rst:509: WARNING: Inline literal start-string without end-string. class_image.rst:422: WARNING: Inline literal start-string without end-string. class_image.rst:434: WARNING: Inline literal start-string without end-string. class_inputevent.rst:74: WARNING: Inline literal start-string without end-string. class_inputeventaction.rst:45: WARNING: Inline literal start-string without end-string. class_inputmap.rst:47: WARNING: Inline literal start-string without end-string. class_kinematicbody.rst:80: WARNING: Inline interpreted text or phrase reference start-string without end-string. class_kinematicbody2d.rst:80: WARNING: Inline interpreted text or phrase reference start-string without end-string. class_line2d.rst:182: WARNING: Inline literal start-string without end-string. class_thread.rst:51: WARNING: Inline literal start-string without end-string. class_treeitem.rst:160: WARNING: Inline literal start-string without end-string.
* Fix class docs, improve error handling of the rst generator.Martin Capitanio2017-11-181-3/+7
| | | | | | | | | | The rst-generator gives you now a hint what's going on: Bad reference: 'method.RegEx.search_all' in file: ../modules/regex/doc_classes/RegExMatch.xml grep 'method.RegEx.search_all' ../modules/regex/doc_classes/RegExMatch.xml Contains the results of a single regex match returned by [method RegEx.search] and [method.RegEx.search_all]. It can be used to find the position and range of the match and its capturing groups, and it can extract its sub-string for you.
* makerst: Remove stray spaces in method signaturesRémi Verschelde2017-10-211-6/+2
|
* makerst: Add support for [member] and [signal]Rémi Verschelde2017-10-211-2/+5
| | | | Part of #11137. [enum] is still missing, and none are implemented in the engine itself yet.
* makerst: Fix rst-ization of members and escaping of [Class]sRémi Verschelde2017-10-211-2/+12
| | | | Fixes #11517.
* makerst: Fix support for module classesRémi Verschelde2017-10-141-12/+8
| | | | | | | | | Previous code expected only one XML per module, which is not the case for e.g. mono or gdnative. Also add newline after signal description to fix rst warning, and make the script Python 3-compatible. [ci skip]
* makerst.py: Support split classes XML and use folders and/or single files as ↵Alexander Meerhoff2017-09-231-24/+30
| | | | | | | | | input The new syntax is (from `doc/`): `tools/makerst.py classes/ ../modules/`. Also adapted `make rst` target accordingly. [ci skip]
* Docs: ignore tags inside code,codeblock tagPoommetee Ketson2017-07-221-8/+17
|
* Add Signals descriptions when they exist.Julian Murgia2017-06-141-0/+6
|
* style: Fix PEP8 blank lines issues in Python filesRémi Verschelde2016-11-011-4/+2
| | | | | | | | | | | Done with `autopep8 --select=E3,W3`, fixes: - E301 - Add missing blank line. - E302 - Add missing 2 blank lines. - E303 - Remove extra blank lines. - E304 - Remove blank line following function decorator. - E309 - Add missing blank line. - W391 - Remove trailing blank lines.
* style: Fix PEP8 whitespace issues in Python filesRémi Verschelde2016-11-011-66/+66
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Done with `autopep8 --select=E2,W2`, fixes: - E201 - Remove extraneous whitespace. - E202 - Remove extraneous whitespace. - E203 - Remove extraneous whitespace. - E211 - Remove extraneous whitespace. - E221 - Fix extraneous whitespace around keywords. - E222 - Fix extraneous whitespace around keywords. - E223 - Fix extraneous whitespace around keywords. - E224 - Remove extraneous whitespace around operator. - E225 - Fix missing whitespace around operator. - E226 - Fix missing whitespace around operator. - E227 - Fix missing whitespace around operator. - E228 - Fix missing whitespace around operator. - E231 - Add missing whitespace. - E231 - Fix various deprecated code (via lib2to3). - E241 - Fix extraneous whitespace around keywords. - E242 - Remove extraneous whitespace around operator. - E251 - Remove whitespace around parameter '=' sign. - E261 - Fix spacing after comment hash. - E262 - Fix spacing after comment hash. - E265 - Format block comments. - E271 - Fix extraneous whitespace around keywords. - E272 - Fix extraneous whitespace around keywords. - E273 - Fix extraneous whitespace around keywords. - E274 - Fix extraneous whitespace around keywords. - W291 - Remove trailing whitespace. - W293 - Remove trailing whitespace.
* style: Start applying PEP8 to Python files, indentation issuesRémi Verschelde2016-11-011-451/+451
| | | | | | | | | | | | | | | | | | | Done with `autopep8 --select=E1`, fixes: - E101 - Reindent all lines. - E112 - Fix under-indented comments. - E113 - Fix over-indented comments. - E115 - Fix under-indented comments. - E116 - Fix over-indented comments. - E121 - Fix a badly indented line. - E122 - Fix a badly indented line. - E123 - Fix a badly indented line. - E124 - Fix a badly indented line. - E125 - Fix indentation undistinguish from the next logical line. - E126 - Fix a badly indented line. - E127 - Fix a badly indented line. - E128 - Fix a badly indented line. - E129 - Fix a badly indented line.
* SCsub: Add python shebang as a hint for syntax highlightingRémi Verschelde2016-10-171-1/+1
| | | | Also switch existing shebangs to "better" /usr/bin/env python.
* classref: Fix UTF-8 parsing in makerstRémi Verschelde2016-06-221-2/+3
|
* Remove trailing spacesRémi Verschelde2016-04-021-11/+11
|
* Add a warning header to each rst fileRémi Verschelde2016-02-171-0/+4
| | | | To tell potential contributors that they should direct their work to the XML template and not the auto-generated reST