Fix conf.py and add requirements.txt for Read the Docs

Author: vsvito420

.readthedocs.yaml

@@ -14,10 +14,7 @@ build:
 sphinx:
    configuration: docs/conf.py
 
-# Optionally, but recommended,
-# declare the Python requirements required to build your documentation
-# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-# python:
-#    install:
-#    - requirements: docs/requirements.txt
-        
+# Declare the Python requirements required to build your documentation
+python:
+   install:
+   - requirements: docs/requirements.txt

docs/conf.py

@@ -4,121 +4,49 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 # -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-
-project = 'learning-python'
-copyright = '2025, v.skolan'
-author = 'v.skolan'
-
-# -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-
-import recommonmark
-from recommonmark.transform import AutoStructify
-
-extensions = [
-    'recommonmark',
-]
-# Configuration file for the Sphinx documentation builder.
-#
-# For the full list of built-in configuration values, see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-
 project = 'learning-python'
 copyright = '2025, v.skolan'
 author = 'v.skolan'
 
 # -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-
-extensions = [
-    'recommonmark',
-]
-html_theme = 'sphinx_rtd_theme'
-html_theme_path = ["_themes"]
-# Configuration file for the Sphinx documentation builder.
-#
-# For the full list of built-in configuration values, see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-
-project = 'learning-python'
-copyright = '2025, v.skolan'
-author = 'v.skolan'
+import sys
+import os
 
-# -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+# Add path to extensions
+sys.path.append(os.path.abspath('.'))
 
 extensions = [
     'recommonmark',
     'sphinx_rtd_theme',
 ]
-html_theme = 'sphinx_rtd_theme'
-html_theme_path = ["_themes"]
-# Configuration file for the Sphinx documentation builder.
-#
-# For the full list of built-in configuration values, see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-# -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+# Add source file types
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
 
-project = 'learning-python'
-copyright = '2025, v.skolan'
-author = 'v.skolan'
-
-# -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-
-extensions = [
-    'recommonmark',
-    'sphinx_rtd_theme',
-]
-html_theme = 'sphinx_rtd_theme'
-html_theme_path = ["_themes"]
-source_suffix = ['.rst', '.md']
-# Configuration file for the Sphinx documentation builder.
-#
-# For the full list of built-in configuration values, see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
+# The master toctree document
+master_doc = 'index'
 
-# -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-
-project = 'learning-python'
-copyright = '2025, v.skolan'
-author = 'v.skolan'
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-# -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+# Language settings
+language = 'de'
 
-extensions = [
-    'recommonmark',
-    'sphinx_rtd_theme',
-]
+# -- Options for HTML output -------------------------------------------------
 html_theme = 'sphinx_rtd_theme'
-html_theme_path = ["_themes"]
-source_suffix = ['.rst', '.md']
+html_static_path = ['_static']
 
+# -- Extension configuration -------------------------------------------------
 def setup(app):
+    from recommonmark.transform import AutoStructify
     app.add_config_value('recommonmark_config', {
             'enable_eval_rst': True,
-            'auto_toc_tree_depth': 2,
+            'auto_toc_tree_section': 'Contents',
+            'enable_math': True,
+            'enable_inline_math': True,
+            'enable_auto_doc_ref': True,
         }, True)
     app.add_transform(AutoStructify)
-
-templates_path = ['_templates']
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
-
-language = 'de'
-
-# -- Options for HTML output -------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-
-html_theme = 'alabaster'
-html_static_path = ['_static']

docs/requirements.txt

@@ -0,0 +1,3 @@
+sphinx>=4.0,<8.0
+recommonmark>=0.5.0
+sphinx-rtd-theme>=1.0.0