chore: docs

Author: wxh06

docs/conf.py

@@ -33,12 +33,20 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.viewcode",
     "sphinx_inline_tabs",
+    "hoverxref.extension",
 ]
+
 intersphinx_mapping = {
     "python": ("https://docs.python.org/zh-cn/3", None),
     "requests": ("https://docs.python-requests.org/zh_CN/latest", None),
     "PIL": ("https://pillow.readthedocs.io/en/stable", None),
 }
+hoverxref_auto_ref = True
+hoverxref_intersphinx = [
+    "python",
+    "requests",
+    "PIL",
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

docs/requirements.txt

@@ -1,3 +1,4 @@
 furo
 sphinx
+sphinx-hoverxref
 sphinx-inline-tabs

setup.cfg

@@ -9,6 +9,7 @@ long_description_content_type = text/markdown
 url = https://github.com/piterator-org/pyluogu
 project_urls =
     Bug Tracker = https://github.com/piterator-org/pyluogu/issues
+    Documentation = https://pyluogu.readthedocs.io/
 classifiers =
     Programming Language :: Python :: 3
     License :: OSI Approved :: MIT License

tox.ini

@@ -14,8 +14,8 @@ deps =
     black
     flake8
 commands =
-    flake8 src tests
-    black src tests
+    flake8
+    black --check .
 
 [testenv:docs]
 allowlist_externals = make