From 9b862150b3bfb7a8ef601d94271878880166a6f8 Mon Sep 17 00:00:00 2001 From: frgfm <26927750+frgfm@users.noreply.github.com> Date: Sat, 6 Aug 2022 18:44:21 +0200 Subject: [PATCH] docs: Fixed installation page indexing --- docs/source/conf.py | 1 + docs/source/core.rst | 5 ++--- docs/source/{installation.rst => installing.rst} | 0 3 files changed, 3 insertions(+), 3 deletions(-) rename docs/source/{installation.rst => installing.rst} (100%) diff --git a/docs/source/conf.py b/docs/source/conf.py index 3d149c64..d4bb8ec0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -93,6 +93,7 @@ "source_repository": "https://github.com/pyronear/pyro-engine/", "source_branch": "develop", "source_directory": "docs/source/", + "sidebar_hide_name": True, } diff --git a/docs/source/core.rst b/docs/source/core.rst index 6f3fbb31..09cb28b2 100644 --- a/docs/source/core.rst +++ b/docs/source/core.rst @@ -5,12 +5,11 @@ The models subpackage contains everything to manage the whole Fire Detection pro by predicting whether there is a fire on this image -.. currentmodule:: pyroengine.core +.. currentmodule:: pyroengine -Engine ------- .. autoclass:: Engine + .. automethod:: clear_cache .. automethod:: predict .. automethod:: heartbeat \ No newline at end of file diff --git a/docs/source/installation.rst b/docs/source/installing.rst similarity index 100% rename from docs/source/installation.rst rename to docs/source/installing.rst