godot/doc/Makefile

BASEDIR = .
CLASSES = "$(BASEDIR)/classes/" "$(BASEDIR)/../modules/" "$(BASEDIR)/../platform/"
OUTPUTDIR = $(BASEDIR)/_build
TOOLSDIR = $(BASEDIR)/tools
JSDIR = "$(BASEDIR)/../platform/web"
LANGARG ?= en
TOOLSOPT ?=

.ONESHELL:

clean:
	rm -rf "$(OUTPUTDIR)"

doxygen:
	rm -rf "$(OUTPUTDIR)/doxygen"
	mkdir -p "$(OUTPUTDIR)/doxygen"
	doxygen Doxyfile

rst:
	rm -rf "$(OUTPUTDIR)/rst"
	mkdir -p "$(OUTPUTDIR)/rst"
	python3 "$(TOOLSDIR)/make_rst.py" -o "$(OUTPUTDIR)/rst" -l "$(LANGARG)" $(TOOLSOPT) $(CLASSES)

xml-check:
	python3 "$(TOOLSDIR)/make_rst.py" --dry-run -l "$(LANGARG)" $(TOOLSOPT) $(CLASSES)

rstjs:
	rm -rf "$(OUTPUTDIR)/rstjs"
	mkdir -p "$(OUTPUTDIR)/rstjs"
	npm --prefix "$(JSDIR)" ci
	npm --prefix "$(JSDIR)" run docs -- --destination "$(OUTPUTDIR)/rstjs/html5_shell_classref.rst"
Fixes doc/Makefile fails if path contains spaces 2022-09-11 15:48:31 +08:00			`BASEDIR = .`
[Export docs] Move docs to platform folders. 2023-04-19 17:23:22 +08:00			`CLASSES = "$(BASEDIR)/classes/" "$(BASEDIR)/../modules/" "$(BASEDIR)/../platform/"`
Add a Makefile to generate classes doc in various formats All the generated documentation is put in doc/_build. 2015-12-13 07:01:04 +08:00			`OUTPUTDIR = $(BASEDIR)/_build`
			`TOOLSDIR = $(BASEDIR)/tools`
Safeguard Makefile commands 2023-02-27 19:24:46 +08:00			`JSDIR = "$(BASEDIR)/../platform/web"`
i18n: Add `--lang` option to `make_rst.py` to write translated headings Add a few missing headings to the translation templates. 2021-12-21 17:53:07 +08:00			`LANGARG ?= en`
Fix translation po file not found when `make rst` 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. 2023-11-19 09:19:45 +08:00			`TOOLSOPT ?=`
Add a Makefile to generate classes doc in various formats All the generated documentation is put in doc/_build. 2015-12-13 07:01:04 +08:00
			`.ONESHELL:`

			`clean:`
Safeguard Makefile commands 2023-02-27 19:24:46 +08:00			`rm -rf "$(OUTPUTDIR)"`
Add a Makefile to generate classes doc in various formats All the generated documentation is put in doc/_build. 2015-12-13 07:01:04 +08:00
			`doxygen:`
Safeguard Makefile commands 2023-02-27 19:24:46 +08:00			`rm -rf "$(OUTPUTDIR)/doxygen"`
			`mkdir -p "$(OUTPUTDIR)/doxygen"`
Add a Makefile to generate classes doc in various formats All the generated documentation is put in doc/_build. 2015-12-13 07:01:04 +08:00			`doxygen Doxyfile`

			`rst:`
Safeguard Makefile commands 2023-02-27 19:24:46 +08:00			`rm -rf "$(OUTPUTDIR)/rst"`
			`mkdir -p "$(OUTPUTDIR)/rst"`
Fix translation po file not found when `make rst` 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. 2023-11-19 09:19:45 +08:00			`python3 "$(TOOLSDIR)/make_rst.py" -o "$(OUTPUTDIR)/rst" -l "$(LANGARG)" $(TOOLSOPT) $(CLASSES)`

			`xml-check:`
			`python3 "$(TOOLSDIR)/make_rst.py" --dry-run -l "$(LANGARG)" $(TOOLSOPT) $(CLASSES)`
[HTML5] Add jsdoc2rst tool. 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. 2021-02-22 13:10:16 +08:00
			`rstjs:`
Safeguard Makefile commands 2023-02-27 19:24:46 +08:00			`rm -rf "$(OUTPUTDIR)/rstjs"`
			`mkdir -p "$(OUTPUTDIR)/rstjs"`
			`npm --prefix "$(JSDIR)" ci`
			`npm --prefix "$(JSDIR)" run docs -- --destination "$(OUTPUTDIR)/rstjs/html5_shell_classref.rst"`