aboutsummaryrefslogtreecommitdiff
path: root/doc/tools
Commit message (Collapse)AuthorAgeFilesLines
* 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-112-0/+7
|
* fixed md scriptYan Pas2018-02-181-8/+13
|
* 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
* doc status: Partial revert of e23454d, setgets are no longer listedRémi Verschelde2017-11-241-18/+2
|
* 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.
* Merge pull request #12053 from Grosskopf/audiodocs-fixRémi Verschelde2017-10-191-5/+6
|\ | | | | filtering getters&setters over strings works for AudioStreamPlayer*
| * filtering getters&setters over strings works for AudioStreamPlayer*Grosskopf2017-10-151-5/+6
| |
* | 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]
* doc_status.py: Error message for unknown CLI flag, switch shebang to pythonmhilbrunner2017-10-071-12/+16
|
* doc_status.py: Add -e (--empty) option to hide items with nothing left to domhilbrunner2017-10-031-0/+15
|
* Merge pull request #11757 from mhilbrunner/doc_status_py27Andreas Haas2017-10-021-4/+14
|\ | | | | doc_status.py Python 2.7 backwards compatibility & Windows support
| * doc_status.py Python 2.7 backwards compatibilitymhilbrunner2017-10-011-4/+14
| |
* | Merge pull request #11654 from bojidar-bg/docstatus-fnmatchPoommetee Ketson2017-10-021-5/+8
|\ \ | |/ |/| Allow using wildcards to filter docstatus class names
| * Allow using wildcards to filter docstatus class namesBojidar Marinov2017-09-281-5/+8
| | | | | | | | [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]
* | Make doc_status output a bit more markdown-friendly, hide some printsBojidar Marinov2017-09-161-4/+7
|/
* Update doc status generator.Daniel J. Ramirez2017-09-151-13/+30
| | | | [ciskip]
* Docs: ignore tags inside code,codeblock tagPoommetee Ketson2017-07-221-8/+17
|
* Add Signals descriptions when they exist.Julian Murgia2017-06-142-0/+12
|
* Doc: Drop unmainted converters for html, textile, dokuwikiRémi Verschelde2017-05-066-1825/+0
|
* Doc: Remove unused tool translationRémi Verschelde2017-05-062-142/+0
|
* Add "Godot Engine contributors" copyright lineRémi Verschelde2017-04-081-0/+1
|
* Fix URLs to moved docs pagesRémi Verschelde2017-04-051-1/+1
| | | | Closes #8266.
* Update classes.xml to master version, add a small feature to doc_statusBojidar Marinov2017-03-291-6/+9
|
* Welcome in 2017, dear changelog reader!Rémi Verschelde2017-01-011-1/+1
| | | | | | | | That year should bring the long-awaited OpenGL ES 3.0 compatible renderer with state-of-the-art rendering techniques tuned to work as low as middle end handheld devices - without compromising with the possibilities given for higher end desktop games of course. Great times ahead for the Godot community and the gamers that will play our games!
* style: Various other PEP8 fixes in Python filesRémi Verschelde2016-11-013-30/+30
| | | | | | | | | | | | Done with `autopep8 --select=E7`, fixes: - E701 - Put colon-separated compound statement on separate lines. - E702 - Put semicolon-separated compound statement on separate lines. - E703 - Put semicolon-separated compound statement on separate lines. - E711 - Fix comparison with None. - E712 - Fix (trivial case of) comparison with boolean. - E713 - Fix (trivial case of) non-membership check. - E721 - Fix various deprecated code (via lib2to3).
* style: Fix PEP8 blank lines issues in Python filesRémi Verschelde2016-11-016-67/+19
| | | | | | | | | | | 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-016-686/+686
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-016-1759/+1759
| | | | | | | | | | | | | | | | | | | 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-177-7/+7
| | | | Also switch existing shebangs to "better" /usr/bin/env python.
* classref: Fix UTF-8 parsing in makerstRémi Verschelde2016-06-221-2/+3
|
* Various improvements to doc_status.pyRémi Verschelde2016-04-261-10/+10
| | | | | | | - Make comments opt-in (smaller table in width) - Reduce length of Brief Description and Description (also smaller table as output) - Make names cyan (blue is too dark on black terminal) - Drop some redundant synonyms for the flags
* Add a python script to check the current doc statusBojidar Marinov2016-04-221-0/+430
|
* Remove trailing spacesRémi Verschelde2016-04-026-284/+284
|
* 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
|
generated by cgit v1.2.3-70-g09d2 (git 2.51.2) at 2025-11-08 13:58:22 +0000