update home page

docs/source/conf.py

@@ -4,30 +4,25 @@
 
 project = "Autosubmit API"
 copyright = "2024, Barcelona Supercomputing Center, BSC"
-author = "Earth Sciences Department, Barcelona Supercomputing Center, BSC"
+author = "Barcelona Supercomputing Center"
 
 release = "4.0.0"
 version = "4.0.0"
 
 # -- General configuration
 
-extensions = [
-    'sphinxcontrib.redoc'
-]
+extensions = ["sphinxcontrib.redoc"]
 
 # -- Options for HTML output
 
 redoc = [
     {
-        'name': 'Autosubmit API',
-        'page': 'api',
-        'spec': '_static/openapi.json',
+        "name": "Autosubmit API",
+        "page": "api",
+        "spec": "_static/openapi.json",
         # 'spec': 'https://petstore3.swagger.io/api/v3/openapi.json',
         # 'spec': 'https://petstore.swagger.io/v2/swagger.json'
-        'opts': {
-            'suppress-warnings': True,
-            'hide-hostname': True
-        }
+        "opts": {"suppress-warnings": True, "hide-hostname": True},
     }
 ]
 
@@ -38,3 +33,29 @@
 html_logo = "_static/Logo.svg"
 
 html_css_files = ["custom.css"]
+
+html_context = {
+    "github_user": "BSC-ES",
+    "github_repo": "autosubmit-api",
+    "github_version": "main",
+}
+
+html_theme_options = {
+    "header_links_before_dropdown": 6,
+    "show_nav_level": 2,
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/BSC-ES/autosubmit-api",
+            "icon": "fa-brands fa-square-github",
+            "type": "fontawesome",
+        },
+    ],
+}
+
+# Add meta tags
+html_meta = {
+    "description": "Autosubmit API documentation",
+    "keywords": "autosubmit, API, documentation, BSC-ES",
+    "author": "BSC-ES",
+}

docs/source/guides/openapi/index.rst

@@ -15,7 +15,7 @@ The OpenAPI specification is generated using the FastAPI library and the Swagger
 
 
 .. figure:: swagger.png
-   :name: authprocess
+   :name: swaggerUI
    :width: 100%
    :align: center
 

docs/source/index.rst

@@ -5,10 +5,65 @@ Autosubmit API
 ##############
 
 
+.. raw:: html
+
+   <div>
+      <div class="row gap-4 mb-4 wrap gap-1">
+         <div class="col" style="min-width: min(400px, 100%)"> 
+         The <b>Autosubmit API</b> is an open-source Python web application that aims to monitor, analyze, and control workflows created and managed with the Autosubmit workflow manager
+         </div>
+         <div class="col d-flex flex-column justify-content-center p-1 bg-black text-white shadow" style="min-width: min(400px, 100%)">
+               <div class="px-2 py-1 font-monospace">$ pip install autosubmit_api</div>
+               <div class="px-2 py-1 font-monospace">$ autosubmit_api start</div>
+         </div>
+      </div>
+   </div>
+
+
 .. toctree::
    :maxdepth: 2
 
    /installation/index
    /configuration/index
    /usage/index
    /guides/index
+
+
+
+.. raw:: html
+
+   <div class="mt-4">
+      <h4 class="text-center mb-4">More about Autosubmit ecosystem</h4>
+      <div class="row gap-4 mb-4 wrap gap-1">
+         <div class="col pt-3 border rounded" style="min-width: 20rem;">
+             <a class="fs-4 fw-semibold" href="https://autosubmit.readthedocs.io/" target="_blank" rel="noreferrer" rel="noopener">
+               Autosubmit workflow manager
+             </a>
+             <p class="mt-2">An open source Python experiment and workflow manager used to manage complex workflows on Cloud and HPC platforms</p>
+         </div>
+         <div class="col pt-3 border rounded" style="min-width: 20rem;">
+             <a class="fs-4 fw-semibold" href="https://autosubmit-gui.readthedocs.io/" target="_blank" rel="noreferrer" rel="noopener">
+               Autosubmit GUI
+             </a>
+             <p class="mt-2">Graphical User Interface that aims to provide users with simplified information from the workflow execution of scientific experiments managed by Autosubmit</p>
+         </div>
+      </div>
+   </div>
+
+
+.. For more information about the **Autosubmit workflow manager**, please visit the `Autosubmit documentation <https://autosubmit.readthedocs.io/en/latest/>`_.
+
+
+Contact Us
+==========
+
+.. list-table::
+  :widths: 20 80
+  :header-rows: 0
+  :stub-columns: 1
+
+  * - GitHub
+    - https://github.com/BSC-ES/autosubmit-api
+  * - Email
+    - [email protected]
+