feat: Create sphinx extension for integrating Flutter apps into the documentation site #1393

st-pasha · 2022-02-22T07:11:46Z

Description

Created new extension that allows integrating Flame/Flutter apps directly into the produced documentation. For example:

 ```{flutter-app}
 :sources: ../_flutter/tetris_tutorial
 :page: step1
 :show: run
 ```

Checklist

The title of my PR starts with a Conventional Commit prefix (fix:, feat:, docs: etc).
I have read the Contributor Guide and followed the process outlined for submitting PRs.
(NA) I have updated/added tests for ALL new/updated/fixed functionality.
I have updated/added relevant documentation in docs and added dartdoc comments with ///.
(NA) I have updated/added relevant examples in examples.

Breaking Change

No, this is not a breaking change.

Related Issues

Closes #1389

…ocumentation site (flame-engine#1393)

* position_type_test * detectors_test * reformat projections_test * Reorganize tests in projector_test * review flame_game_test * move some cameratests * created viewport_test file * reformat camera tests * feat: Add missing optional priority to SpriteBodyComponent (#1404) * Add missing optional priority to SpriteBodyComponent Gives you the option to set the priority directly when creating the component. * Add optional parameter priority Adds priority as an optional parameter * removed wrong trailing comma Added a comma at the wrong position. * feat: Added getImageLayer to flame_tiled (#1405) * feat: Create sphinx extension for integrating Flutter apps into the documentation site (#1393) Co-authored-by: KurtLa <KurtLa@users.noreply.github.com> Co-authored-by: Munsterlander <munsterlander@users.noreply.github.com> Co-authored-by: Erick <erickzanardoo@gmail.com>

…ocumentation site (flame-engine#1393)

* position_type_test * detectors_test * reformat projections_test * Reorganize tests in projector_test * review flame_game_test * move some cameratests * created viewport_test file * reformat camera tests * feat: Add missing optional priority to SpriteBodyComponent (flame-engine#1404) * Add missing optional priority to SpriteBodyComponent Gives you the option to set the priority directly when creating the component. * Add optional parameter priority Adds priority as an optional parameter * removed wrong trailing comma Added a comma at the wrong position. * feat: Added getImageLayer to flame_tiled (flame-engine#1405) * feat: Create sphinx extension for integrating Flutter apps into the documentation site (flame-engine#1393) Co-authored-by: KurtLa <KurtLa@users.noreply.github.com> Co-authored-by: Munsterlander <munsterlander@users.noreply.github.com> Co-authored-by: Erick <erickzanardoo@gmail.com>

* ProcessQueues() method * Added deadQueue in LifecycleManager * refactor removeFromParent() * make shouldRemove non-overridable * Added lifecycle state "removing" * prevent double-removal * shouldRemove can only be set to true * eliminate _shouldRemove * rename _dead -> _dying * added adoption queue * removed nextParent * deprecate ComponentSet.clear and .removeAll * ComponentSet no longer handles removal * remove usages of shouldRemove * doc-comments * onRemove refactor * cleanup * remove obsolete paragraph in docs * rename queue dying -> removals * feat: update examples dashbook (#1398) * docs: Added tutorial for creating a bare Flame project (#1376) * feat: Add missing optional priority to SpriteBodyComponent (#1404) * Add missing optional priority to SpriteBodyComponent Gives you the option to set the priority directly when creating the component. * Add optional parameter priority Adds priority as an optional parameter * removed wrong trailing comma Added a comma at the wrong position. * feat: Added getImageLayer to flame_tiled (#1405) * feat: Create sphinx extension for integrating Flutter apps into the documentation site (#1393) * feat: adding FlameBloc mixin to allow its usage with enhanced FlameGame classes (#1399) * feat: adding FlameBloc mixin to allow its usage with enhanced FlameGame classes * fixing tests * Apply suggestions from code review Co-authored-by: Lukas Klingsbo <me@lukas.fyi> Co-authored-by: Pasha Stetsenko <stpasha@google.com> Co-authored-by: Luan Nico <luanpotter27@gmail.com> Co-authored-by: Lukas Klingsbo <me@lukas.fyi> Co-authored-by: Pasha Stetsenko <stpasha@google.com> Co-authored-by: Luan Nico <luanpotter27@gmail.com> * refactor: Organize tests in the game/ folder (#1403) * position_type_test * detectors_test * reformat projections_test * Reorganize tests in projector_test * review flame_game_test * move some cameratests * created viewport_test file * reformat camera tests * feat: Add missing optional priority to SpriteBodyComponent (#1404) * Add missing optional priority to SpriteBodyComponent Gives you the option to set the priority directly when creating the component. * Add optional parameter priority Adds priority as an optional parameter * removed wrong trailing comma Added a comma at the wrong position. * feat: Added getImageLayer to flame_tiled (#1405) * feat: Create sphinx extension for integrating Flutter apps into the documentation site (#1393) Co-authored-by: KurtLa <KurtLa@users.noreply.github.com> Co-authored-by: Munsterlander <munsterlander@users.noreply.github.com> Co-authored-by: Erick <erickzanardoo@gmail.com> * feat: improving generics on position body component (#1397) * chore(release): publish packages (#1407) - flame@1.1.0-releasecandidate.1 - flame_bloc@1.2.0-releasecandidate.1 - flame_rive@1.1.0-releasecandidate.1 - flame_test@1.2.0-releasecandidate.1 - flame_tiled@1.3.0-releasecandidate.1 * chore: fixing pub deps to allow publish (#1408) * chore(release): publish packages - flame@1.1.0-releasecandidate.1 - flame_bloc@1.2.0-releasecandidate.1 - flame_rive@1.1.0-releasecandidate.1 - flame_test@1.2.0-releasecandidate.1 - flame_tiled@1.3.0-releasecandidate.1 * chore: fixing deps to enable pub publish * fixing vector math version * chore(flame_forge2d): export all files in barrel file (#1409) * chore(release): publish packages (#1410) - flame_forge2d@0.9.0-releasecandidate.1 * chore: commented out PR template sections (#1412) * feat: Make ContactCallback begin end methods optional overrides (#1415) * feat: made begin and end optional overrides * chore: removed unecessary end override * feat: Camera as a component (#1355) * feat(collision detection)!: Use a broadphase to make collision detection more efficient (#1252) * fix: PositionBodyComponent had an async onMount, without needing (#1424) * fix: Fix collision detection comments and typo (#1422) * Fix collision detection comments and typo * Update packages/flame/lib/src/collisions/collision_callbacks.dart Co-authored-by: Pasha Stetsenko <stpasha@google.com> * Update doc/flame/collision_detection.md Co-authored-by: Pasha Stetsenko <stpasha@google.com> Co-authored-by: Pasha Stetsenko <stpasha@google.com> * feat: adding has mounted to component (#1418) * feat: adding has mounted to component * feat: pr suggestions * feat: improving hasMounted * feat: renaming hasMounted to mounted * feat: pr suggestion * chore(release): publish packages (#1427) - flame_svg@1.1.0-releasecandidate.1 - flame@1.1.0-releasecandidate.2 - flame_bloc@1.2.0-releasecandidate.2 - flame_forge2d@0.9.0-releasecandidate.2 - flame_rive@1.1.0-releasecandidate.2 - flame_test@1.2.0-releasecandidate.2 - flame_tiled@1.3.0-releasecandidate.2 * fix a test * fix broken merge * rename parent->owner in LifecycleManager * update doc-comment Co-authored-by: Erick <erickzanardoo@gmail.com> Co-authored-by: KurtLa <KurtLa@users.noreply.github.com> Co-authored-by: Munsterlander <munsterlander@users.noreply.github.com> Co-authored-by: Lukas Klingsbo <me@lukas.fyi> Co-authored-by: Luan Nico <luanpotter27@gmail.com> Co-authored-by: Allison Ryan <77211884+allisonryan0002@users.noreply.github.com> Co-authored-by: Alejandro Santiago <dev@alestiago.com>

st-pasha added 9 commits February 21, 2022 00:23

wip on new tutorial system

4ab8aa9

wip

13cf0cc

Merge branch 'main' into ps/tutorial-in-docs

4e07677

Merge branch 'main' into ps/tutorial-in-docs

0f66ec6

implement flutter-app extension

52b5f15

remove temp files

bacf592

add some doc-comments in the js file

92a6494

better organize code in flutter_app.py

3e2917d

Add docs for FlutterAppDirective

bc99469

spydon requested review from spydon, erickzanardo, luanpotter, renancaraujo and wolfenrain February 24, 2022 18:57

spydon approved these changes Feb 24, 2022

View reviewed changes

st-pasha and others added 2 commits February 24, 2022 20:10

Merge branch 'main' into ps/tutorial-in-docs

620244c

Merge branch 'main' into ps/tutorial-in-docs

8a33ce5

spydon enabled auto-merge (squash) February 27, 2022 21:13

spydon merged commit 2935a6a into flame-engine:main Feb 27, 2022

st-pasha added a commit to st-pasha/flame that referenced this pull request Feb 27, 2022

feat: Create sphinx extension for integrating Flutter apps into the d…

c59abc6

…ocumentation site (flame-engine#1393)

st-pasha added a commit to st-pasha/flame that referenced this pull request Mar 9, 2022

feat: Create sphinx extension for integrating Flutter apps into the d…

f2f3824

…ocumentation site (flame-engine#1393)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Create sphinx extension for integrating Flutter apps into the documentation site #1393

feat: Create sphinx extension for integrating Flutter apps into the documentation site #1393

st-pasha commented Feb 22, 2022 •

edited

Loading

feat: Create sphinx extension for integrating Flutter apps into the documentation site #1393

feat: Create sphinx extension for integrating Flutter apps into the documentation site #1393

Conversation

st-pasha commented Feb 22, 2022 • edited Loading

Description

Checklist

Breaking Change

Related Issues

st-pasha commented Feb 22, 2022 •

edited

Loading