From 340e3dbbcbd9a1a95c839787dc95f41189c97324 Mon Sep 17 00:00:00 2001 From: kokarare1212 Date: Sun, 16 May 2021 08:08:54 +0900 Subject: [PATCH] Update document --- docs/conf.py | 8 ++++++++ docs/index.md | 3 +++ 2 files changed, 11 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 71b6389..bd4e4fd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -11,6 +11,7 @@ # import os # import sys # sys.path.insert(0, os.path.abspath('.')) +from recommonmark.transform import AutoStructify # -- Project information ----------------------------------------------------- project = "librespot-python" @@ -51,3 +52,10 @@ source_suffix = [".rst", ".md"] source_parsers = { ".md": "recommonmark.parser.CommonMarkParser", } + + +def setup(app): + app.add_config_value("recommonmark_config", { + "auto_toc_tree_section": "Contents", + }, True) + app.add_transform(AutoStructify) diff --git a/docs/index.md b/docs/index.md index 85b5518..36ded34 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,6 +3,9 @@ ![](https://img.shields.io/github/forks/kokarare1212/librespot-python.svg) [![](https://deepsource.io/gh/kokarare1212/librespot-python.svg/?label=active+issues&show_trend=true)](https://deepsource.io/gh/kokarare1212/librespot-python/?ref=repository-badge) # Get Started +## Contents +* [Supported Futures](supported.md) +* [API Reference](api.md) ## What's librespot-python? librespot-python is a python port of Spotify's open source client library [librespot](https://github.com/librespot-org/librespot). It was created to play Spotify on various platforms and devices.