summaryrefslogtreecommitdiff
path: root/doc/tools
AgeCommit message (Collapse)Author
2020-02-01Improve the `doc_status.py` console outputHugo Locurcio
- 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-01-26doc: Drop unused 'category' property from headerRémi Verschelde
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-24Count theme items in doc_status.pyTomasz Chabora
2020-01-24makerst: Escape reST markup after enumsRémi Verschelde
Fixes #35501.
2020-01-20makerst: Use code markup for default values/overridesRémi Verschelde
Fixes godotengine/godot-docs#3071.
2020-01-15doc: Move the class description to be just below the brief descriptionHugo Locurcio
- 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.
2019-12-06Add a pre-commit hook to check the class reference syntaxHugo Locurcio
This also makes documentation helper scripts executable.
2019-12-04Travis CI: Run `makerst.py` to check for documentation errorsHugo Locurcio
2019-11-29makerst: Escape default values using reST markupRémi Verschelde
Otherwise the docs would complain about values like "godot_" which reST tries to interpret as an identifier.
2019-10-24makerst: Separate signals/enums/properties/methods with a lineHugo Locurcio
2019-10-08Fixed AttributeError on doc_status.pySamuelDeboni
2019-10-01Print errors when tab indent found in [codeblock]Yeongho Kim
2019-09-04Add overriden properties to the documentationBojidar Marinov
Fixes #31855
2019-07-25Adds a meta on top of every generated class to hide 'Edit on Github' linkStraToN
Linked docs issue https://github.com/godotengine/godot-docs/pull/2656
2019-06-27Add default values to the editor help, docs, and generated RSTBojidar Marinov
Also, make spacing of "=" in the editor help a bit more consistent. Closes #16086
2019-06-11makerst: Fix format of [url] links in reSTRémi Verschelde
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-05-16Add support for [url=] tag to makerst.pyStanislav
Fixes #28904
2019-04-19doc: Drop unused <demos> tagRémi Verschelde
2019-04-06Remove unused importsHendrikto
2019-03-29ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass]Ignacio Etcheverry
Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29EditorHelp, makerst: Improve enum ref resolving and constant ref supportIgnacio Etcheverry
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-10doc: Fix style for vararg in makerstRémi Verschelde
2019-03-05makerst: make vararg methods look the same as in editor helpmerumelu
2018-12-28makerst.py refactor.Pieter-Jan Briers
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.
2018-12-27Clean up & improve makerst.pyPieter-Jan Briers
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
2018-12-11Enabled rst files to escape for parentheses after bracketsJoão Álvaro Ferreira
2018-11-05doc: Use HTTPS for docs.godotengine.org and point to latest branchRémi Verschelde
Fixes #23509.
2018-10-27Dont use equality operators with None singleton in python fileslupoDharkael
2018-10-02Add extra newline after enum members and constants, to ensure they'll format ↵LikeLakers2
properly after a multi-line description
2018-10-02doc: Drop obsolete makemd.py, dates back to GitHub Wiki daysRémi Verschelde
It has not been kept in sync with makerst.py, so it does not serve much purpose nowadays.
2018-09-21doc: Fixes to rst converterRémi Verschelde
2018-09-20Fix the weird method linking issue when the previous method's description ↵LikeLakers2
ends with a code block
2018-09-13doc: Make property sections in rst similar to editor docsRémi Verschelde
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.
2018-09-13Doc: Use PascalCase names in hyperlinksRémi Verschelde
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.
2018-09-12Doc: Use same headers and order in-editor and onlineRémi Verschelde
2018-06-12Add support for tutorial links to makerst.pyrobojumper
Also change the <tutorials> structure to make use of individual <link> tags
2018-05-31makerst.py: Properly escape \ for rstRémi Verschelde
Fixes godotengine/godot-docs#1486.
2018-05-12Makes doc methods display enums.Pieter-Jan Briers
2018-03-11Properly closing all files in Python codeViktor Ferenczi
2018-02-18fixed md scriptYan Pas
2018-02-16Documentation tool does not add escapes to code and codeblocksAnish
Instead of adding the escapes to all * and _ the tool now excludes the characters inside [code] and [codeblock]. Resolves: #15156
2017-12-22Enums get listed in the docs and enum members now also link to theJoachim Meyer
corresponding enum in the webdocs Fixes #13254
2017-11-24doc status: Partial revert of e23454d, setgets are no longer listedRémi Verschelde
2017-11-19Fix the class docs for the rst-syntax errors.Martin Capitanio
- 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.
2017-11-18Fix class docs, improve error handling of the rst generator.Martin Capitanio
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.
2017-10-21makerst: Remove stray spaces in method signaturesRémi Verschelde
2017-10-21makerst: Add support for [member] and [signal]Rémi Verschelde
Part of #11137. [enum] is still missing, and none are implemented in the engine itself yet.
2017-10-21makerst: Fix rst-ization of members and escaping of [Class]sRémi Verschelde
Fixes #11517.
2017-10-19Merge pull request #12053 from Grosskopf/audiodocs-fixRémi Verschelde
filtering getters&setters over strings works for AudioStreamPlayer*
2017-10-15filtering getters&setters over strings works for AudioStreamPlayer*Grosskopf
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-07 22:16:51 +0000