feat: add initial Read the Docs configuration and update README with hero image

This commit is contained in:
Christian Krakau-Louis
2025-04-04 00:11:17 +02:00
parent bd3d9ca775
commit 8e22ef0f61
4 changed files with 52 additions and 0 deletions
+22
View File
@@ -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
+4
View File
@@ -5,6 +5,10 @@
# DocuElevate
<div align="center">
<a href="https://www.docuelevate.org"><img src="frontend/static/hero.png" alt="DocuElevate Logo" width="80%" /></a>
</div>
## Overview
DocuElevate automates the handling, extraction, and processing of documents using a variety of services, including:
Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 MiB

+26
View File
@@ -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