9 Commits

Author SHA1 Message Date
0c451577e9 docs: Docs reorganization (#2063) 2022-10-23 23:02:49 +02:00
4ed776862e docs!: replace doc-build-live with doc-serve (#2078)
This commit replaces the melos doc-build-live with melos doc-serve.

This also changes documentation for this while removing the mention of make commands in the documentation.
2022-10-15 13:36:57 +00:00
a956350b78 docs: Fix documentation markup errors (#2022)
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.
2022-10-05 08:02:20 +00:00
b720657187 docs: Updated the required python version (#1991) 2022-10-02 20:31:54 +02:00
8b56c5477b fix: Ignore the build directories for sphinx builds (#1984)
If we don't ignore the build directories it will build multiple times unnecessarily when doing the live build.
2022-10-02 06:45:41 -04:00
50d4482dc6 docs: Update docs about how to build the docs (#1970)
* docs: Update docs about how to build the docs

* Change name on sphinx targets

* Add doc-live-build
2022-09-30 19:03:04 +00:00
de04514e29 ci: Markdown linting (#1920)
Adds markdown linting to the CI and fixes up all the current files.
2022-09-19 21:17:50 +00:00
58571141bc docs: Added ability to create infobox-style widgets in the documentation (#1771)
Additional mode "infobox" allows Flutter widgets to be inserted into the generated documentation site as wikipedia-style infoboxes floating on the right. This is useful for presenting content to the user up-front without sacrificing the flow of the exposition. For example, currently the Tap Events demo is "hidden" in the middle of a long page.

We believe that presenting the content in this way would make the user more excited to read about it.
2022-07-02 01:02:19 +02:00
ea354e3a81 docs: Documenting how to write documentation (#1721)
Since our documentation is fairly complex, we need to have a document which describes how various parts of it work. This PR adds such documentation.
2022-06-14 16:45:48 +02:00