feat: format api doc

ICIJ · Feb 7, 2024 · ae99fea · ae99fea
1 parent 0f983fc
commit ae99fea
Show file tree

Hide file tree

Showing 4 changed files with 104 additions and 8 deletions.
diff --git a/prophecies/settings/base.py b/prophecies/settings/base.py
@@ -235,7 +235,7 @@
 }
 
 SPECTACULAR_SETTINGS = {
-    "TITLE": "Prophecies API",
+    "TITLE": "Prophecies",
     "DESCRIPTION": """Prophecies is a platform to fact check data collaboratively. 
     It is a free open-source software developed by the International Consortium of Investigative Journalists (ICIJ).
     """,

diff --git a/prophecies/static/docs/api.html b/prophecies/static/docs/api.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
-  <title>Prophecies API</title>
+  <title>API - Prophecies</title>
   <link rel="preconnect" href="https://unpkg.com">
   <link rel="preconnect" href="https://fonts.googleapis.com">
   <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
@@ -17,22 +17,30 @@
       --font-mono: "SF Mono",ui-monospace,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;
       --font-code: var(--font-mono);
 
-      --color-canvas-100: #E9EFEE;
-      --color-canvas-200: #fff;
-      --color-primary-tint: #98BFBE;
-
+      --color-canvas-100: #e9efee;
+      --color-canvas-200: rgba(255, 255, 255, 0.4);
+      --color-border: rgb(227, 232, 237);
+      
       --color-primary: #235B59;
+      --color-primary-tint: rgba(255, 255, 255, 0.8);
       --color-success: #73B782;
       --color-danger: #FE6565;
       --color-warning: #e49c00;
     }
 
-    :root .sl-inverted, [data-theme="light"] .sl-inverted, [data-theme="light"] .sl-inverted .sl-inverted .sl-inverted {
+    :root .sl-inverted, 
+    [data-theme="light"] .sl-inverted, 
+    [data-theme="light"] .sl-inverted .sl-inverted .sl-inverted {
       --color-canvas: #142b2a;
     }
   </style>
 </head>
 <body>
-  <elements-api apiDescriptionUrl="./openapi.yml" router="hash" layout="responsive" hideTryIt="true" />
+  <elements-api 
+    apiDescriptionUrl="./openapi.yml"
+    logo="./logo.svg"
+    router="hash"
+    layout="responsive"
+    hideTryIt="true" />
 </body>
 </html>
diff --git a/prophecies/static/docs/favicon.ico b/prophecies/static/docs/favicon.ico
diff --git a/prophecies/static/docs/logo.svg b/prophecies/static/docs/logo.svg