From 24956a12ca40a6c3fee6a43ec18af693510bf9f4 Mon Sep 17 00:00:00 2001 From: Suitably Mysterious Date: Sun, 10 Aug 2025 16:05:57 +0000 Subject: [PATCH] allow readthedocs to be implemented --- .readthedocs.yaml | 22 ++++++++++++++++++++++ docs/index.md | 1 + mkdocs.yml | 5 +++++ 3 files changed, 28 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..bb3b083 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +# Read the Docs configuration file +# 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-24.04 + tools: + python: "3.13" + +# Build documentation with Mkdocs +mkdocs: + configuration: mkdocs.yml + +# 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 \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..2a048a5 --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +# Welcome to Library System! \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..9845d41 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,5 @@ +site_name: Library System +theme: + name: readthedocs +nav: + - Home: index.md \ No newline at end of file