summaryrefslogtreecommitdiff
path: root/doc/Makefile
AgeCommit message (Collapse)Author
2023-03-13Safeguard Makefile commandskobewi
(cherry picked from commit d29030fdd082632b7b004bdc52826b3d8e2759f0)
2022-09-11Fixes doc/Makefile fails if path contains spacesVoylin
2022-08-29[Web] Rename JavaScript platform to Web.Fabio Alessandrelli
Also rename export name from "HTML5" to "Web".
2021-12-21i18n: Add `--lang` option to `make_rst.py` to write translated headingsRémi Verschelde
Add a few missing headings to the translation templates.
2021-10-24Rename "makerst.py" to "make_rst.py"Aaron Franke
2021-02-26[HTML5] Add jsdoc2rst tool.Fabio Alessandrelli
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.
2020-03-25SCons: Drop support for Python 2Rémi Verschelde
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).
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
2017-10-14makerst: Fix support for module classesRémi Verschelde
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]
2017-09-23makerst.py: Support split classes XML and use folders and/or single files as ↵Alexander Meerhoff
input The new syntax is (from `doc/`): `tools/makerst.py classes/ ../modules/`. Also adapted `make rst` target accordingly. [ci skip]
2017-05-06Doc: Drop unmainted converters for html, textile, dokuwikiRémi Verschelde
2016-02-07Enhance xml to rst converterRémi Verschelde
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
2015-12-13Add a Makefile to generate classes doc in various formatsRémi Verschelde
All the generated documentation is put in doc/_build.