mirror of
https://github.com/flame-engine/flame.git
synced 2026-03-13 09:43:03 +08:00
3c550f883b
The FlameGame lifecycle diagram is incorrect. The lifecycle for a FlameGame is as follows: onGameResize onLoad onMount render update onRemove onGameResize onLoad onMount render update Note in particular the onGameResize is before onLoad and the render and update are reversed. Because they are different, this PR creates a new lifecycle diagram that is not shared with Component. It also fixes the Component lifecycle diagram to be consistent with the FlameGame lifecycle diagram formatting and terms.
33 lines
1.2 KiB
Makefile
33 lines
1.2 KiB
Makefile
# Minimal makefile for Sphinx documentation
|
|
|
|
#
|
|
# To build the documentation you need to have Python3 installed
|
|
# and working with pip, as well as Flutter of course. Then run
|
|
# the following:
|
|
#
|
|
# dart pub global activate melos
|
|
# dart pub global activate dartdoc_json
|
|
# pip install sphinx sphinxcontrib sphinxcontrib-mermaid sphinxcontrib-jquery myst_parser sphinx-autobuild sphinx-copybutton
|
|
#
|
|
|
|
# You can set these variables from the command line.
|
|
# SPHINXOPTS and SPHINXBUILD can also be set from the environment.
|
|
SOURCEDIR = $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))/..
|
|
SPHINXOPTS ?= -c "${SOURCEDIR}/_sphinx"
|
|
SPHINXBUILD ?= sphinx-build
|
|
BUILDDIR = "${SOURCEDIR}/_build"
|
|
|
|
# Put it first so that "make" without argument is like "make help".
|
|
help:
|
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
.PHONY: help Makefile
|
|
|
|
livehtml:
|
|
sphinx-autobuild $(SOURCEDIR) $(BUILDDIR)/html $(SPHINXOPTS) $(O) --ignore "**/.*" --ignore "*build*" --open-browser
|
|
|
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
|
%: Makefile
|
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|