From a67dec39f73a67fdb848a743c8c6b4dc4a4792b3 Mon Sep 17 00:00:00 2001 From: Munsterlander Date: Wed, 5 Oct 2022 14:15:15 -0700 Subject: [PATCH] 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. --- doc/README.md | 2 +- doc/_sphinx/conf.py | 1 - doc/_sphinx/theme/layout.html | 3 +-- doc/flame_audio/audio.md | 2 +- doc/index.md | 1 + doc/resources/resources.md | 6 ++++++ 6 files changed, 10 insertions(+), 5 deletions(-) create mode 100644 doc/resources/resources.md diff --git a/doc/README.md b/doc/README.md index a56eac4ce..49909c2fc 100644 --- a/doc/README.md +++ b/doc/README.md @@ -35,7 +35,7 @@ Put the pub package as your dependency by putting the following in your `pubspec ```yaml dependencies: - flame: + flame: --VERSION-- ``` The latest version can be found on [pub.dev](https://pub.dev/packages/flame/install). diff --git a/doc/_sphinx/conf.py b/doc/_sphinx/conf.py index a8a9f870b..18908e16f 100644 --- a/doc/_sphinx/conf.py +++ b/doc/_sphinx/conf.py @@ -85,7 +85,6 @@ class TitleCollector(docutils.nodes.SparseNodeVisitor): self.level -= 1 - def get_local_toc(document): if not document: return "" diff --git a/doc/_sphinx/theme/layout.html b/doc/_sphinx/theme/layout.html index 5648a4bb6..504bbf91f 100644 --- a/doc/_sphinx/theme/layout.html +++ b/doc/_sphinx/theme/layout.html @@ -85,8 +85,7 @@ - - +