diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..4670ed8 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,23 @@ +# 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/home.md b/docs/home.md new file mode 100644 index 0000000..3e0077f --- /dev/null +++ b/docs/home.md @@ -0,0 +1,3 @@ +# Home +## Welcome to the PlexStream Docs +This documentation was writted by snoopythe3, in progress. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..27212b9 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,7 @@ +theme: + name: mkdocs + site_name: Plexstream Docs + repo_url: https://github.com/PlexStream/plexstream/ + site_description: Official Documentation From PlexStream + site_author: snoopythe3 + docs_dir: docs \ No newline at end of file