summaryrefslogtreecommitdiffstats
path: root/doc/Makefile
Commit message (Collapse)AuthorAgeFilesLines
* Fix translation po file not found when `make rst`风青山2023-11-191-2/+5
| | | | | | | | | | | | The parsed language parameters contain unstripped spaces. This will generate a wrong path. Provide a `TOOLSOPT` to allow overriding the default values of parameters of the `make_rst.py` script. The xml generated by `godot --doctool -l LANG` can be checked for errors using `make xml-check LANGARG=LANG`, which may be useful for checking errors in po files.
* [Export docs] Move docs to platform folders.bruvzg2023-04-201-1/+1
|
* Safeguard Makefile commandskobewi2023-02-271-12/+12
|
* Fixes doc/Makefile fails if path contains spacesVoylin2022-09-111-1/+1
|
* [Web] Rename JavaScript platform to Web.Fabio Alessandrelli2022-08-291-1/+1
| | | | Also rename export name from "HTML5" to "Web".
* i18n: Add `--lang` option to `make_rst.py` to write translated headingsRémi Verschelde2021-12-211-1/+3
| | | | Add a few missing headings to the translation templates.
* Rename "makerst.py" to "make_rst.py"Aaron Franke2021-10-241-1/+1
|
* [HTML5] Add jsdoc2rst tool.Fabio Alessandrelli2021-02-261-3/+8
| | | | | | | | | | | A template for `jsdoc` that generat the HTML5 public classref. The script can be run via `npm run docs` to print to stdout. You can dry run via `npm run docs -- --d dry-run` or write to file via `npm run docs -- -d /path/to/file.rst` Also update Makefile in `doc/` and add dry run test to CI.
* SCons: Drop support for Python 2Rémi Verschelde2020-03-251-7/+0
| | | | | | We now require SCons 3.0+ (first version with Python 3 support), and we set min required Python 3 version to 3.5 (3.4 and earlier are EOL).
* Clean up & improve makerst.pyPieter-Jan Briers2018-12-271-1/+1
| | | | | | | | | | | | | | 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
* makerst: Fix support for module classesRémi Verschelde2017-10-141-1/+1
| | | | | | | | | 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-1/+1
| | | | | | | | | input The new syntax is (from `doc/`): `tools/makerst.py classes/ ../modules/`. Also adapted `make rst` target accordingly. [ci skip]
* Doc: Drop unmainted converters for html, textile, dokuwikiRémi Verschelde2017-05-061-19/+0
|
* Enhance xml to rst converterRémi Verschelde2016-02-071-1/+1
| | | | | | | | | | 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
* Add a Makefile to generate classes doc in various formatsRémi Verschelde2015-12-131-0/+47
All the generated documentation is put in doc/_build.