fix(docs): set fallback version for setuptools-scm to fix autodoc import errors on Read the Docs

Author: SunsetWolf

Makefile

@@ -113,7 +113,7 @@ dev: prerequisite all
 
 # Check lint with black.
 black:
-	black . -l 120 --check --diff
+	black . -l 120 --check --diff --exclude qlib/_version.py
 
 # Check code folder with pylint.
 # TODO: These problems we will solve in the future. Important among them are: W0221, W0223, W0237, E1102

pyproject.toml

@@ -117,3 +117,4 @@ qrun = "qlib.cli.run:run"
 [tool.setuptools_scm]
 local_scheme = "no-local-version"
 version_scheme = "guess-next-dev"
+write_to = "qlib/_version.py"

qlib/__init__.py

@@ -4,7 +4,10 @@
 
 from setuptools_scm import get_version
 
-__version__ = get_version(root="..", relative_to=__file__)
+try:
+    from ._version import version as __version__
+except ImportError:
+    __version__ = get_version(root="..", relative_to=__file__)
 __version__bak = __version__  # This version is backup for QlibConfig.reset_qlib_version
 import logging
 import os

setup.py

@@ -4,12 +4,6 @@
 from setuptools import Extension, setup
 
 
-def read(rel_path: str) -> str:
-    here = os.path.abspath(os.path.dirname(__file__))
-    with open(os.path.join(here, rel_path), encoding="utf-8") as fp:
-        return fp.read()
-
-
 NUMPY_INCLUDE = numpy.get_include()