summaryrefslogtreecommitdiffstats
path: root/doc/tools/makerst.py
Commit message (Collapse)AuthorAgeFilesLines
...
* 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
* Implement support for [codeblock] tag in helpRémi Verschelde2016-02-171-3/+42
| | | | | It allows to define a multiline space-indented code block that will be properly parsed by the reST converter for the online docs. The in-editor help understand the [codeblock] tag as it supposedly understand [code] already (i.e. it just seems to discard it, though the code was supposed to switch it to a monospace font, but that's likely another issue.
* Improve parsing of [method ...] tagsRémi Verschelde2016-02-071-2/+2
| | | | Also improve some code display.
* Fix badly formatted tags in XMLRémi Verschelde2016-02-071-2/+4
| | | | Also add parsing of [code] tags in RST converter
* Display better inheritance info in docJuan Linietsky2016-02-071-1/+35
|
* Small makerst improvementsRémi Verschelde2016-02-071-9/+27
|
* Enhance xml to rst converterRémi Verschelde2016-02-071-25/+50
| | | | | | | | | | Fixes a number of issues: - Headings underliners now have the correct length - Newline+Tabs in descriptions are replaced by two newlines to make a proper paragraph - [br] are replaced by two newlines, making a proper paragraph - Properly parse internal hyperlinks in constants description - Fix broken internal links due to missing newlines - Show method header even when it has no description, to have something to reference in hyperlinks
* -Added RST generator for class referenceJuan Linietsky2016-02-061-0/+396