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

docs: Fix documentation markup errors (#2022)

Browse Source 
Fix several errors reported during documentation build.
Generally speaking,

```foo

would be interpreted as a code block with the language foo; while

```{foo}

would be interpreted as a Sphinx directive .. foo.
This commit is contained in:
Pasha Stetsenko
2022-10-05 01:02:20 -07:00
committed by GitHub
parent 3d043b86f7
commit a956350b78
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/development/documentation.md
View File

@ -22,7 +22,7 @@ section will focus on the Markdown extensions that are enabled in our build syst
The table of contents for the site must be created manually. This is done using special `{toctree}` The table of contents for the site must be created manually. This is done using special `{toctree}`
blocks, one per each subdirectory: blocks, one per each subdirectory:
`````{markdown} `````markdown
```{toctree} ```{toctree}
:hidden: :hidden:
@ -40,7 +40,7 @@ the toctrees -- otherwise you will see a warning during the build that the docum
Admonitions are emphasized blocks of text with a distinct appearance. They are created using the Admonitions are emphasized blocks of text with a distinct appearance. They are created using the
triple-backticks syntax: triple-backticks syntax:
`````{markdown} `````markdown
```{note} ```{note}
Please note this very important caveat. Please note this very important caveat.
``` ```
@ -77,7 +77,7 @@ Also check out this cool thingy.
The special `{deprecated}` block can be used to mark some part of documentation or syntax as being The special `{deprecated}` block can be used to mark some part of documentation or syntax as being
deprecated. This block requires specifying the version when the deprecation has occurred deprecated. This block requires specifying the version when the deprecation has occurred
`````{markdown} `````markdown
```{deprecated} v1.3.0 ```{deprecated} v1.3.0
Please use this **other** thing instead. Please use this **other** thing instead.
@ -99,7 +99,7 @@ Flutter widgets and embedding them alongside with the overall documentation cont
In Markdown, the code for inserting an embed looks like this: In Markdown, the code for inserting an embed looks like this:
`````{markdown} `````markdown
```{flutter-app} ```{flutter-app}
:sources: ../flame/examples :sources: ../flame/examples
:page: tap_events :page: tap_events
@ -191,7 +191,7 @@ Then you can open the site at `http://localhost:8000/`.
If you ever run the **melos doc-clean** or the **make clean** command, the server will need to be If you ever run the **melos doc-clean** or the **make clean** command, the server will need to be
restarted, because the clean command deletes the entire `html` directory. restarted, because the clean command deletes the entire `html` directory.
```note ```{note}
Avoid having spaces in the paths to the docs since that will keep you from Avoid having spaces in the paths to the docs since that will keep you from
building the project due to building the project due to
[this bug](https://github.com/ipython/ipython/pull/13765). [this bug](https://github.com/ipython/ipython/pull/13765).