Merge pull request #202 from mull-project/stanislaw/python_313

Upgrade to new Read the Docs config

Author: stanislaw

.readthedocs.yaml

@@ -12,10 +12,14 @@ sphinx:
 # Optionally build your docs in additional formats such as PDF and ePub
 formats:
 - pdf
+# - epub
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.5
   install:
-    - requirements: docs/requirements.txt
-
+    - requirements: requirements.dev.txt

docs/conf.py

@@ -3,6 +3,8 @@
 # This file only contains a selection of the most common options. For a full
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
+import os
+import sys
 
 # -- Path setup --------------------------------------------------------------
 
@@ -16,14 +18,28 @@
 
 import guzzle_sphinx_theme
 
+try:
+    filecheck_root_path = os.path.abspath(
+        os.path.join(os.path.dirname(__file__), "..")
+    )
+    if not os.path.isdir(filecheck_root_path):
+        raise FileNotFoundError
+    sys.path.append(filecheck_root_path)
+    from filecheck.filecheck import __version__ as filecheck_version
+except Exception as exception:
+    print(  # noqa: T201
+        f"Could not resolve a path to filecheck's root: {exception}"
+    )
+    sys.exit(1)
+
 # -- Project information -----------------------------------------------------
 
 project = "FileCheck.py"
 copyright = "2019-2023, Stanislav Pankevich"
 author = "Stanislav Pankevich"
 
 # The full version, including alpha/beta/rc tags
-release = "0.0.1"
+release = filecheck_version
 
 
 # -- General configuration ---------------------------------------------------
@@ -51,8 +67,6 @@
 extensions.append("guzzle_sphinx_theme")
 html_theme = "guzzle_sphinx_theme"
 
-# html_theme = 'pyramid'
-
 html_theme_options = {
     "project_nav_name": "Mull",
 }

requirements.dev.txt

@@ -11,3 +11,6 @@ flake8>=3.9.2
 coverage>=5.4
 pytest>=6.2.2
 lit>=0.9
+
+# Docs
+guzzle_sphinx_theme