diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..af3cd331 --- /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: requirements.txt \ No newline at end of file diff --git a/README.md b/README.md index dcf88984..d245523d 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,10 @@ # DocuElevate +
+ DocuElevate Logo +
+ ## Overview DocuElevate automates the handling, extraction, and processing of documents using a variety of services, including: diff --git a/frontend/static/hero.png b/frontend/static/hero.png new file mode 100644 index 00000000..c5de6277 Binary files /dev/null and b/frontend/static/hero.png differ diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..a4233893 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,26 @@ +site_name: DocuElevate +site_description: Intelligent Document Processing & Management +site_url: https://docuelevate.readthedocs.io/ +repo_url: https://github.com/christianlouis/DocuElevate +repo_name: DocuElevate +repo_type: github +theme: + name: material + logo: frontend/static/logo_writing.svg + favicon: frontend/static/logo_writing.svg + features: + - navigation.tabs + - navigation.instant + - search.suggest + - content.code.copy +nav: + - Home: index.md + - User Guide: user-guide.md + - API: api.md + - Deployment: deployment.md + - Configuration: + - Overview: configuration.md + - Dropbox: integrations/dropbox.md + - Google Drive: integrations/google-drive.md + - OneDrive: integrations/onedrive.md + - Troubleshooting: troubleshooting.md