changeset 435:4b74e44900d2

Add .readthedocs.yaml
author Amine Sehili <amine.sehili@gmail.com>
date Wed, 30 Oct 2024 22:00:59 +0100
parents 0f8f60771784
children 87048a881402 2644f997b6e0
files .readthedocs.yaml doc/conf.py
diffstat 2 files changed, 32 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/.readthedocs.yaml	Wed Oct 30 22:00:59 2024 +0100
@@ -0,0 +1,31 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the "doc/" directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional 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
--- a/doc/conf.py	Wed Oct 30 17:23:49 2024 +0100
+++ b/doc/conf.py	Wed Oct 30 22:00:59 2024 +0100
@@ -15,7 +15,6 @@
 import ast
 import os
 import re
-import shlex
 import sys
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -64,7 +63,7 @@
 
 # General information about the project.
 project = "auditok"
-copyright = "2015-2021, Amine Sehili"
+copyright = "2015-2024, Amine Sehili"
 author = "Amine Sehili"
 
 # The version info for the project you're documenting, acts as replacement for