Scrameupeutchi/librespot-python
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update document

Browse Source
This commit is contained in:
kokarare1212
2021-05-16 08:08:54 +09:00
parent 6508215af1
commit 340e3dbbcb
2 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/conf.py
View File

@@ -11,6 +11,7 @@
# import os # import os
# import sys # import sys
# sys.path.insert(0, os.path.abspath('.')) # sys.path.insert(0, os.path.abspath('.'))
from recommonmark.transform import AutoStructify
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = "librespot-python" project = "librespot-python"
@@ -51,3 +52,10 @@ source_suffix = [".rst", ".md"]
source_parsers = { source_parsers = {
".md": "recommonmark.parser.CommonMarkParser", ".md": "recommonmark.parser.CommonMarkParser",
} }
def setup(app):
app.add_config_value("recommonmark_config", {
"auto_toc_tree_section": "Contents",
}, True)
app.add_transform(AutoStructify)

3
docs/index.md
View File

@@ -3,6 +3,9 @@
![](https://img.shields.io/github/forks/kokarare1212/librespot-python.svg) ![](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) [![](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 # Get Started
## Contents
* [Supported Futures](supported.md)
* [API Reference](api.md)
## What's librespot-python? ## What's librespot-python?
librespot-python is a python port of Spotify's open source client library [librespot](https://github.com/librespot-org/librespot). 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. It was created to play Spotify on various platforms and devices.