flutter/flame
1
0
Fork 0
mirror of https://github.com/flame-engine/flame.git synced 2025-11-03 04:18:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix table of content (#2938)

Browse Source 
Removes the accidentally extra added toc and bumps all dependencies.
This commit is contained in:
Lukas Klingsbo
2023-12-20 20:27:36 +01:00
committed by GitHub
parent 5fd0ba3dd5
commit bf91ba9fe0
4 changed files with 16 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/README.md
View File

@ -68,10 +68,3 @@ If you are building a multiplayer game, here are some recommendations of package
- [Firebase](https://firebase.google.com/): Provides dozens of services that can be used to write - [Firebase](https://firebase.google.com/): Provides dozens of services that can be used to write
simpler multiplayer experiences. simpler multiplayer experiences.
- [Supabase](https://supabase.com/): A cheaper alternative to Firebase, based on Postgres. - [Supabase](https://supabase.com/): A cheaper alternative to Firebase, based on Postgres.
```{toctree}
:hidden:
Bridge Packages <bridge_packages/bridge_packages.md>
```

16
doc/_sphinx/requirements.txt
View File

@ -1,10 +1,10 @@
linkify-it-py==2.0.0 linkify-it-py==2.0.2
myst-parser==1.0.0 myst-parser==2.0.0
Pygments==2.15.0 Pygments==2.17.2
Sphinx==6.1.3 Sphinx==7.2.6
sphinxcontrib-mermaid==0.8.1 sphinxcontrib-mermaid==0.9.2
sphinxcontrib-jquery==4.0 sphinxcontrib-jquery==4.1
sphinx-autobuild==2021.3.14 sphinx-autobuild==2021.3.14
sphinx-copybutton==0.5.1 sphinx-copybutton==0.5.2
Jinja2==3.1.2 Jinja2==3.1.2
psutil==5.9.4 psutil==5.9.7

6
doc/flame/rendering/text_rendering.md
View File

@ -243,7 +243,7 @@ this section is for you.
The following diagram showcases the class and inheritance structure of the text rendering pipeline: The following diagram showcases the class and inheritance structure of the text rendering pipeline:
```mermaid ```{mermaid}
%%{init: { 'theme': 'dark' } }%% %%{init: { 'theme': 'dark' } }%%
classDiagram classDiagram
%% renderers %% renderers
@ -466,7 +466,7 @@ defined in the `FlameTextStyle` class.
The actual nodes all inherit from `TextNode` and are broken down by the following diagram: The actual nodes all inherit from `TextNode` and are broken down by the following diagram:
```mermaid ```{mermaid}
%%{init: { 'theme': 'dark' } }%% %%{init: { 'theme': 'dark' } }%%
graph TD graph TD
%% Config %% %% Config %%
@ -542,7 +542,7 @@ to, and can be thought of as, CSS definitions.
The full inheritance chain can be seen on the following diagram: The full inheritance chain can be seen on the following diagram:
```mermaid ```{mermaid}
%%{init: { 'theme': 'dark' } }%% %%{init: { 'theme': 'dark' } }%%
classDiagram classDiagram
%% Nodes %% %% Nodes %%

8
melos.yaml
View File

@ -58,11 +58,11 @@ scripts:
doc-setup: doc-setup:
run: > run: >
echo Checking python version: && echo Checking python version: &&
python --version && python3 --version &&
(python -c "import sys; sys.exit(0 if sys.version_info >= (3,8) else 2)" || (python3 -c "import sys; sys.exit(0 if sys.version_info >= (3,8) else 2)" ||
(echo Error: Python 3.8+ is required && exit 1)) && (echo Error: Python 3.8+ is required && exit 1)) &&
echo Installing required python modules: && echo Installing required python modules: &&
python -m pip install -r "$MELOS_ROOT_PATH/doc/_sphinx/requirements.txt" && python3 -m pip install -r "$MELOS_ROOT_PATH/doc/_sphinx/requirements.txt" &&
echo Installing dartdoc_json: && echo Installing dartdoc_json: &&
dart pub global activate dartdoc_json && dart pub global activate dartdoc_json &&
echo Done. echo Done.
@ -77,7 +77,7 @@ scripts:
description: Recompiles the docs every time there is a change in them and opens your browser. description: Recompiles the docs every time there is a change in them and opens your browser.
doc-kill: doc-kill:
run: cd "$MELOS_ROOT_PATH/doc/_sphinx" && python kill-server.py run: cd "$MELOS_ROOT_PATH/doc/_sphinx" && python3 kill-server.py
description: Kills any TCP processes running on port 8000. description: Kills any TCP processes running on port 8000.
doc-clean: doc-clean: