flutter/flame
1
0
Fork 0
mirror of https://github.com/flame-engine/flame.git synced 2025-10-29 16:05:47 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: Added links to API and Examples in doc sidebar (#1997)

Browse Source 
Based on a brief discussion with Spydon, this adds two links in the docs sidebar to API docs on pub.dev as well as a link to the flame examples.
This commit is contained in:
Munsterlander
2022-10-05 14:15:15 -07:00
committed by GitHub
parent 0ee9898b86
commit a67dec39f7
6 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/README.md
View File

@ -35,7 +35,7 @@ Put the pub package as your dependency by putting the following in your `pubspec
```yaml ```yaml
dependencies: dependencies:
flame: <VERSION> flame: --VERSION--
``` ```
The latest version can be found on [pub.dev](https://pub.dev/packages/flame/install). The latest version can be found on [pub.dev](https://pub.dev/packages/flame/install).

1
doc/_sphinx/conf.py
View File

@ -85,7 +85,6 @@ class TitleCollector(docutils.nodes.SparseNodeVisitor):
self.level -= 1 self.level -= 1
def get_local_toc(document): def get_local_toc(document):
if not document: if not document:
return "" return ""

3
doc/_sphinx/theme/layout.html
View File

@ -85,8 +85,7 @@
<a href="{{pathto('index')}}" class="logo_image"> <a href="{{pathto('index')}}" class="logo_image">
<img src="{{pathto('_static/logo_flame.png', 1)}}"> <img src="{{pathto('_static/logo_flame.png', 1)}}">
</a> </a>
<div class="highlight-box" role="alert" style="display:none"> <div class="highlight-box" role="alert" style="display:none">
<div> <div>
<div class="title">highlighted:</div> <div class="title">highlighted:</div>

2
doc/flame_audio/audio.md
View File

@ -7,7 +7,7 @@ list in your `pubspec.yaml` file:
```yaml ```yaml
dependencies: dependencies:
flame_audio: <VERSION> flame_audio: VERSION
``` ```
The latest version can be found on [pub.dev](https://pub.dev/packages/flame_audio/install). The latest version can be found on [pub.dev](https://pub.dev/packages/flame_audio/install).

1
doc/index.md
View File

@ -10,4 +10,5 @@ flame_forge2d <flame_forge2d/flame_forge2d.md>
Tutorials <tutorials/tutorials.md> Tutorials <tutorials/tutorials.md>
Other Modules <other_modules/other_modules.md> Other Modules <other_modules/other_modules.md>
Development <development/development.md> Development <development/development.md>
Resources <resources/resources.md>
``` ```

6
doc/resources/resources.md Normal file
View File

@ -0,0 +1,6 @@
# Resources
```{toctree}
Flame API <https://pub.dev/documentation/flame/--VERSION--/>
Flame Examples <https://examples.flame-engine.org/#/>
```