diff --git a/.gitignore b/.gitignore index f70051c..0cf458d 100644 --- a/.gitignore +++ b/.gitignore @@ -6,4 +6,5 @@ dist/ .vscode/ .coverage coverage* -junit.xml \ No newline at end of file +junit.xml +.venv/ \ No newline at end of file diff --git a/README.md b/README.md index e480b56..b2848e9 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ A simple API wrapper for [topstats.gg](https://topstats.gg) written in Python. ## Getting started -Make sure you already have an API token handy. See [this page](https://docs.topstats.gg/authentication/tokens) on how to retrieve it. +Make sure you already have an API token handy. See [this page](https://docs.topstats.gg/docs/authentication/tokens) on how to retrieve it. After that, run the following command in your terminal: diff --git a/docs/_static/banner-dark-mode.svg b/docs/_static/banner-dark-mode.svg new file mode 100644 index 0000000..73186ad --- /dev/null +++ b/docs/_static/banner-dark-mode.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/_static/banner-light-mode.svg b/docs/_static/banner-light-mode.svg new file mode 100644 index 0000000..175d019 --- /dev/null +++ b/docs/_static/banner-light-mode.svg @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100644 index 0000000..cb9bd62 Binary files /dev/null and b/docs/_static/favicon.ico differ diff --git a/docs/conf.py b/docs/conf.py index 06858ed..7d2a783 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -36,5 +36,24 @@ ] html_js_files = ['script.js'] html_static_path = ['_static'] +html_theme_options = { + 'light_logo': 'banner-light-mode.svg', + 'dark_logo': 'banner-dark-mode.svg', + 'sidebar_hide_name': True, + 'top_of_page_buttons': ['edit'], + 'footer_icons': [ + { + 'name': 'GitHub', + 'url': 'https://github.com/top-stats/python-sdk', + 'html': """ + + + + """, + 'class': '', + }, + ], +} html_theme = 'furo' html_title = project +html_favicon = '_static/favicon.ico' diff --git a/topstats/__init__.py b/topstats/__init__.py index 6030c96..a8ea101 100644 --- a/topstats/__init__.py +++ b/topstats/__init__.py @@ -22,7 +22,7 @@ __maintainer__ = __author__ __status__ = 'Production' __license__ = 'MIT' -__copyright__ = 'Copyright (c) 2020 Arthurdw; Copyright (c) 2024-2025 null8626' +__copyright__ = 'Copyright (c) 2020 Arthurdw; Copyright (c) 2024-2026 null8626' __version__ = VERSION __all__ = ( 'Bot',