Skip to content

Commit 4d09395

Browse files
arthurbrennoarthurbrenno
committed
docs: testing new index.html
1 parent d17a49a commit 4d09395

File tree

4 files changed

+88
-19
lines changed

4 files changed

+88
-19
lines changed

‎.github/workflows/sphinx.yaml‎

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,29 @@ jobs:
2727
- name: Install PIP
2828
run: pip install --root-user-action=ignore --upgrade pip
2929

30-
- name: Install project dependencies for docs using pip # Use uv and dev dependencies
31-
run: pip install sphinx furo
30+
- name: Install project dependencies for docs using pip
31+
run: |
32+
pip install -e .
33+
pip install sphinx furo
3234
33-
- name: Build Docs # Use your makefile to build docs
34-
run: make docs # This will execute 'make docs' in your root directory
35+
- name: Build Sphinx Documentation
36+
run: |
37+
cd docs
38+
make html
39+
touch build/html/.nojekyll # Add .nojekyll file to disable Jekyll processing
3540
3641
- name: Prepare Deployment Directory
3742
run: |
38-
mkdir -p deploy_output/docs # Create deploy_output and docs subdirectory in one go
39-
cp docs/index.html deploy_output/index.html # Copy index.html to staging root
40-
cp -r docs/build/html/* deploy_output/docs # Copy ALL Sphinx output to staging/docs
43+
mkdir -p deploy_output
44+
cp -r docs/logo.png deploy_output/
45+
cp docs/index.html deploy_output/index.html
46+
cp -r docs/build/html deploy_output/build/html
47+
touch deploy_output/.nojekyll # Add .nojekyll in the root
4148
42-
- name: Deploy to GitHub Pages # Using peaceiris/actions-gh-pages - a popular action
49+
- name: Deploy to GitHub Pages
4350
uses: peaceiris/actions-gh-pages@v3
4451
if: github.ref == 'refs/heads/master'
4552
with:
4653
github_token: ${{ secrets.GITHUB_TOKEN }}
47-
publish_dir: ./deploy_output # Publish the staging directory
54+
publish_dir: ./deploy_output
55+
enable_jekyll: false

‎docs/404.html‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<title>Page Not Found - Agentle</title>
7+
<!-- Tailwind CSS -->
8+
<script src="https://cdn.tailwindcss.com"></script>
9+
<script>
10+
tailwind.config = {
11+
theme: {
12+
extend: {
13+
fontFamily: {
14+
sans: ['Inter', 'sans-serif'],
15+
},
16+
colors: {
17+
primary: {
18+
500: '#FFC300', /* Main gold */
19+
},
20+
dark: {
21+
900: '#121212', /* Main black */
22+
}
23+
}
24+
}
25+
}
26+
}
27+
</script>
28+
<!-- Fonts: Inter -->
29+
<link rel="preconnect" href="https://fonts.googleapis.com">
30+
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
31+
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700;800&display=swap" rel="stylesheet">
32+
</head>
33+
<body class="bg-dark-900 text-white font-sans flex items-center justify-center min-h-screen">
34+
<div class="max-w-md mx-auto text-center px-4">
35+
<img src="./logo.png" alt="Agentle Logo" class="h-24 mx-auto mb-6">
36+
<h1 class="text-4xl font-bold mb-4">404 - Page Not Found</h1>
37+
<p class="text-gray-300 mb-8">The page you're looking for doesn't exist or has been moved.</p>
38+
<div class="space-y-4">
39+
<a href="./index.html" class="block w-full py-3 px-4 bg-primary-500 text-dark-900 font-bold rounded-md hover:bg-opacity-90 transition">
40+
Go to Homepage
41+
</a>
42+
<a href="./build/html/index.html" class="block w-full py-3 px-4 border border-primary-500 text-primary-500 font-medium rounded-md hover:bg-dark-800 transition">
43+
Go to Documentation
44+
</a>
45+
<a href="https://github.com/arthurbrenno/agentle" class="block w-full py-3 px-4 border border-gray-600 text-gray-300 font-medium rounded-md hover:bg-dark-800 transition">
46+
View on GitHub
47+
</a>
48+
</div>
49+
</div>
50+
</body>
51+
</html>

‎docs/index.html‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -65,14 +65,14 @@
6565
<div class="flex justify-between h-16">
6666
<div class="flex items-center">
6767
<a href="#" class="flex-shrink-0 flex items-center">
68-
<img class="h-10 w-auto" src="logo.png" alt="Agentle Logo">
68+
<img class="h-10 w-auto" src="./logo.png" alt="Agentle Logo">
6969
<span class="ml-2 text-xl font-bold text-primary-500">Agentle</span>
7070
</a>
7171
</div>
7272
<div class="hidden sm:ml-6 sm:flex sm:items-center sm:space-x-8">
7373
<a href="#features" class="text-gray-300 hover:text-primary-400 px-3 py-2 text-sm font-medium">Features</a>
7474
<a href="#examples" class="text-gray-300 hover:text-primary-400 px-3 py-2 text-sm font-medium">Examples</a>
75-
<a href="build/html/index.html" class="text-gray-300 hover:text-primary-400 px-3 py-2 text-sm font-medium">Documentation</a>
75+
<a href="./build/html/index.html" class="text-gray-300 hover:text-primary-400 px-3 py-2 text-sm font-medium">Documentation</a>
7676
<a href="https://github.com/arthurbrenno/agentle" class="text-gray-300 hover:text-primary-400 px-3 py-2 text-sm font-medium flex items-center" target="_blank">
7777
<svg class="h-5 w-5 mr-1" fill="currentColor" viewBox="0 0 24 24" aria-hidden="true">
7878
<path fill-rule="evenodd" d="M12 2C6.477 2 2 6.484 2 12.017c0 4.425 2.865 8.18 6.839 9.504.5.092.682-.217.682-.483 0-.237-.008-.868-.013-1.703-2.782.605-3.369-1.343-3.369-1.343-.454-1.158-1.11-1.466-1.11-1.466-.908-.62.069-.608.069-.608 1.003.07 1.531 1.032 1.531 1.032.892 1.53 2.341 1.088 2.91.832.092-.647.35-1.088.636-1.338-2.22-.253-4.555-1.113-4.555-4.951 0-1.093.39-1.988 1.029-2.688-.103-.253-.446-1.272.098-2.65 0 0 .84-.27 2.75 1.026A9.564 9.564 0 0112 6.844c.85.004 1.705.115 2.504.337 1.909-1.296 2.747-1.027 2.747-1.027.546 1.379.202 2.398.1 2.651.64.7 1.028 1.595 1.028 2.688 0 3.848-2.339 4.695-4.566 4.943.359.309.678.92.678 1.855 0 1.338-.012 2.419-.012 2.747 0 .268.18.58.688.482A10.019 10.019 0 0022 12.017C22 6.484 17.522 2 12 2z" clip-rule="evenodd"></path>
@@ -99,7 +99,7 @@
9999
<div class="px-2 pt-2 pb-3 space-y-1 bg-dark-800">
100100
<a href="#features" class="block px-3 py-2 rounded-md text-base font-medium text-gray-300 hover:text-primary-400 hover:bg-dark-700">Features</a>
101101
<a href="#examples" class="block px-3 py-2 rounded-md text-base font-medium text-gray-300 hover:text-primary-400 hover:bg-dark-700">Examples</a>
102-
<a href="build/html/index.html" class="block px-3 py-2 rounded-md text-base font-medium text-gray-300 hover:text-primary-400 hover:bg-dark-700">Documentation</a>
102+
<a href="./build/html/index.html" class="block px-3 py-2 rounded-md text-base font-medium text-gray-300 hover:text-primary-400 hover:bg-dark-700">Documentation</a>
103103
<a href="https://github.com/arthurbrenno/agentle" class="block px-3 py-2 rounded-md text-base font-medium text-gray-300 hover:text-primary-400 hover:bg-dark-700" target="_blank">GitHub</a>
104104
<a href="https://pypi.org/project/agentle/" class="block px-3 py-2 rounded-md text-base font-medium text-dark-900 bg-primary-500 hover:bg-primary-400" target="_blank">Install</a>
105105
</div>
@@ -121,7 +121,7 @@ <h1 class="text-4xl tracking-tight font-extrabold sm:text-5xl xl:text-6xl">
121121
</p>
122122
<div class="mt-8 sm:flex sm:justify-center lg:justify-start">
123123
<div class="rounded-md shadow">
124-
<a href="build/html/index.html" class="w-full flex items-center justify-center px-8 py-3 border border-transparent text-base font-bold rounded-md text-dark-900 bg-primary-500 hover:bg-primary-400 md:py-4 md:text-lg md:px-10">
124+
<a href="./build/html/index.html" class="w-full flex items-center justify-center px-8 py-3 border border-transparent text-base font-bold rounded-md text-dark-900 bg-primary-500 hover:bg-primary-400 md:py-4 md:text-lg md:px-10">
125125
Get Started
126126
</a>
127127
</div>
@@ -467,7 +467,7 @@ <h2 class="text-3xl font-extrabold text-white sm:text-4xl">
467467
</p>
468468
<div class="mt-10 flex justify-center">
469469
<div class="inline-flex rounded-md shadow">
470-
<a href="build/html/index.html" class="inline-flex items-center justify-center px-5 py-3 border border-transparent text-base font-bold rounded-md text-dark-900 bg-primary-500 hover:bg-primary-400">
470+
<a href="./build/html/index.html" class="inline-flex items-center justify-center px-5 py-3 border border-transparent text-base font-bold rounded-md text-dark-900 bg-primary-500 hover:bg-primary-400">
471471
Read the docs
472472
</a>
473473
</div>
@@ -488,10 +488,10 @@ <h2 class="text-3xl font-extrabold text-white sm:text-4xl">
488488
<div>
489489
<h3 class="text-sm font-semibold text-primary-500 tracking-wider uppercase">Documentation</h3>
490490
<ul class="mt-4 space-y-4">
491-
<li><a href="build/html/index.html" class="text-base text-gray-300 hover:text-primary-400">Getting Started</a></li>
492-
<li><a href="build/html/api/index.html" class="text-base text-gray-300 hover:text-primary-400">API Reference</a></li>
493-
<li><a href="build/html/examples.html" class="text-base text-gray-300 hover:text-primary-400">Examples</a></li>
494-
<li><a href="build/html/contributing.html" class="text-base text-gray-300 hover:text-primary-400">Contributing</a></li>
491+
<li><a href="./build/html/index.html" class="text-base text-gray-300 hover:text-primary-400">Getting Started</a></li>
492+
<li><a href="./build/html/api/index.html" class="text-base text-gray-300 hover:text-primary-400">API Reference</a></li>
493+
<li><a href="./build/html/examples.html" class="text-base text-gray-300 hover:text-primary-400">Examples</a></li>
494+
<li><a href="./build/html/contributing.html" class="text-base text-gray-300 hover:text-primary-400">Contributing</a></li>
495495
</ul>
496496
</div>
497497
<div>
@@ -505,7 +505,7 @@ <h3 class="text-sm font-semibold text-primary-500 tracking-wider uppercase">Comm
505505
<div>
506506
<h3 class="text-sm font-semibold text-primary-500 tracking-wider uppercase">Resources</h3>
507507
<ul class="mt-4 space-y-4">
508-
<li><a href="build/html/examples.html" class="text-base text-gray-300 hover:text-primary-400">Code Examples</a></li>
508+
<li><a href="./build/html/examples.html" class="text-base text-gray-300 hover:text-primary-400">Code Examples</a></li>
509509
<li><a href="https://github.com/arthurbrenno/agentle/releases" class="text-base text-gray-300 hover:text-primary-400">Releases</a></li>
510510
<li><a href="https://pypi.org/project/agentle/" class="text-base text-gray-300 hover:text-primary-400">PyPI Package</a></li>
511511
</ul>

‎docs/source/conf.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,16 @@
5353
html_static_path = ["_static"]
5454
html_title = f"{project} {release} Documentation"
5555

56+
# Copy the logo to the build directory
57+
html_logo = "../logo.png"
58+
html_favicon = "../logo.png"
59+
60+
# Ensure the right output paths for GitHub Pages
61+
html_baseurl = "https://paragon-intelligence.github.io/agentle/"
62+
63+
# Disable use of file modification times in output
64+
html_last_updated_fmt = ""
65+
5666
# Intersphinx mapping
5767
intersphinx_mapping = {
5868
"python": ("https://docs.python.org/3", None),

0 commit comments

Comments
 (0)