15 Commits

Author SHA1 Message Date
3b87e838f6 docs: Create "dart" domain extension (#2278)
In Sphinx, there is a concept of a "domain", which enables documenting library object such as classes and functions, and then referencing them from any other place in the documentation. This PR adds such a domain for the Dart language.

With the new approach, a class/function can be documented using the following directive:

```{dartdoc}
📦 flame
:symbol: GameWidget
:file: src/game/game_widget/game_widget.dart
```

The documentation will then be automatically extracted from the referenced file using the dartdoc_json tool (published as a separate package), and then rendered inside the page. The screenshot below shows an example of how DialogueRunner class from Jenny would be rendered:

<image>

Once a symbol has been documented using the dartdoc directive, it can be referenced from other places in the documentation as

{ref}`DialogueRunner`
2023-01-25 21:17:25 +00:00
a99c930381 docs: Description of jenny package (#2102)
Adding preliminary description for the jenny project
2022-12-16 07:57:06 +01:00
6d9bb7c354 docs: Added new directive {package} (#2128)
* Add {package} directive

* move css into a separate file

* Use {package} in Other Modules
2022-10-28 23:26:15 +01:00
d0a865f835 docs: Formatting clean up in the flame_tiled docs (#2127) 2022-10-28 11:18:25 +01:00
0c451577e9 docs: Docs reorganization (#2063) 2022-10-23 23:02:49 +02:00
a67dec39f7 docs: Added links to API and Examples in doc sidebar (#1997)
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.
2022-10-05 21:15:15 +00:00
c306b30933 docs: Auto expand flame section on documentation home page (#1823) (#1826)
add an event listener to the docs site to listen everytime on load, then
expand the first expandable section ("flame") if the current page is
home page.
2022-07-28 12:19:37 +02:00
21b06a0fc0 docs: Revert auto expand flame section on documentation home page (#1824) 2022-07-27 23:39:50 +02:00
f0b883be98 docs: Auto expand flame section on documentation home page (#1823)
add an event listener to the docs site to listen everytime on load, then
expand the first expandable section ("flame") if the current page is
home page.
2022-07-27 21:09:41 +02:00
2935a6a55d feat: Create sphinx extension for integrating Flutter apps into the documentation site (#1393) 2022-02-27 21:25:33 +00:00
12cf8f7096 docs: Upgrade documentation site (#1365) 2022-02-13 07:50:13 +01:00
341d227bfc Rewrite effects documentation (#1169)
* Rewrite effects documentation

* implement suggestions

Co-authored-by: Lukas Klingsbo <lukas.klingsbo@gmail.com>
2021-12-07 11:41:04 +01:00
bd36ef2f4f Fix documentation warnings (#1110)
Co-authored-by: Lukas Klingsbo <lukas.klingsbo@gmail.com>
2021-11-17 10:00:41 +00:00
07b95cef30 Documentation version selector (#1024)
* Simpler css injection

* Better menu for selecting documentation version

* Auto-detect current docs version

* Use let/const instead of var, and single quotes

* Added versions file

* Updated script to use template strings

* Update script to load the list of versions dynamically

* Use main branch as a source for versions.txt file
2021-10-21 08:52:01 +03:00
acb66ef7b5 Sphinx docs (#966) 2021-10-01 13:16:42 -04:00