godot/doc/Makefile

BASEDIR = $(CURDIR)
CLASSES = $(BASEDIR)/classes/ $(BASEDIR)/../modules/
OUTPUTDIR = $(BASEDIR)/_build
TOOLSDIR = $(BASEDIR)/tools
JSDIR = $(BASEDIR)/../platform/javascript

.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 $(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
Add a Makefile to generate classes doc in various formats All the generated documentation is put in doc/_build. 2015-12-12 23:01:04 +00:00			`BASEDIR = $(CURDIR)`
makerst.py: Support split classes XML and use folders and/or single files as input The new syntax is (from `doc/`): `tools/makerst.py classes/ ../modules/`. Also adapted `make rst` target accordingly. [ci skip] 2017-09-22 14:55:48 +00:00			`CLASSES = $(BASEDIR)/classes/ $(BASEDIR)/../modules/`
Add a Makefile to generate classes doc in various formats All the generated documentation is put in doc/_build. 2015-12-12 23:01:04 +00:00			`OUTPUTDIR = $(BASEDIR)/_build`
			`TOOLSDIR = $(BASEDIR)/tools`
[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 05:10:16 +00:00			`JSDIR = $(BASEDIR)/../platform/javascript`
Add a Makefile to generate classes doc in various formats All the generated documentation is put in doc/_build. 2015-12-12 23:01:04 +00:00
			`.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`
Rename "makerst.py" to "make_rst.py" 2021-10-24 06:48:03 +00:00			`python3 $(TOOLSDIR)/make_rst.py -o $(OUTPUTDIR)/rst $(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 05:10:16 +00:00
			`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`