Improved Docs (#11)

* Added github links

* Decreased font size

* Added Dark Mode

Author: cemde

CHANGELOG.md

@@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Documentation formatting improved. Added darkmode and links to `Github` (PR: #11).
 - `FileResultLogger` now accepts `pathlib.Path` for argument `output_dir` and has an `overwrite` argument to prevent overwriting of existing logs files.
 
 ### Fixed

docs/assets/favicon.svg

@@ -36,22 +36,19 @@
   border-bottom: 1px solid
     color-mix(in srgb, var(--maseval-teal-primary) 25%, transparent);
   margin-bottom: 0.5rem;
-  font-size: 1.1rem;
 }
 
 /* Make the object name (like class names) more prominent */
 .doc .doc-object-name,
 .doc .doc-class-name {
   font-weight: 700;
   color: var(--maseval-teal-dark);
-  font-size: 1.15rem;
 }
 
 /* Cleaner label chips with teal theme */
 .doc-label {
   border-radius: 8px;
   padding: 2px 6px;
-  font-size: 0.8rem;
   background-color: color-mix(
     in srgb,
     var(--maseval-teal-primary) 12%,
@@ -106,7 +103,6 @@
 
 /* Smaller signature font in code boxes */
 .doc-signature pre code {
-  font-size: 0.825rem !important;
   line-height: 1.4;
 }
 
@@ -119,25 +115,8 @@
   margin-bottom: 0.3rem;
 }
 
-/* Increase font size in parameter tables/details */
-.doc-parameters,
-.doc-other-parameters,
-.doc-returns,
-.doc-raises {
-  font-size: 0.85rem !important;
-}
-
-/* Unified font size for all code elements */
-.md-typeset code {
-  font-size: 0.85rem !important;
-}
-
-.md-typeset pre code {
-  font-size: 0.85rem !important;
-}
-
-/* Subtle teal-themed code background */
-.md-typeset code:not(.doc-symbol-heading) {
+/* Subtle teal-themed inline code background */
+.md-typeset code:not(pre code):not(.doc-symbol-heading) {
   background: color-mix(in srgb, var(--maseval-teal-primary) 8%, transparent);
   padding: 0.05rem 0.3rem;
   border-radius: 4px;
@@ -146,25 +125,6 @@
     color-mix(in srgb, var(--maseval-teal-primary) 15%, transparent);
 }
 
-/* Normalize font size in example code blocks */
-.doc-contents .highlight pre,
-.doc-contents .highlight code,
-.doc-contents pre code {
-  font-size: 0.85rem !important;
-}
-
-/* Normalize text size in docstring content - examples, descriptions */
-.doc-contents .md-typeset,
-.doc-contents p,
-.doc-contents li {
-  font-size: 0.85rem !important;
-}
-
-/* Ensure admonitions (note, warning boxes) have unified text size */
-.doc-contents .admonition {
-  font-size: 0.85rem !important;
-}
-
 /* More compact vertical rhythm in docstrings */
 .doc-contents .md-typeset p {
   margin: 0.4rem 0;
@@ -183,7 +143,6 @@
 
 /* Reduce section heading size in docstrings */
 .doc-section-title {
-  font-size: 0.95rem;
   font-weight: 600;
   color: var(--maseval-teal-primary);
   margin-top: 0.8rem;

docs/css/mkdocstrings.css

@@ -2,16 +2,39 @@ site_name: Multi-Agent System Evaluation
 site_description: "System-level multi-agent benchmarks"
 docs_dir: docs
 site_dir: site
+site_author: ParameterLab
+site_url: https://maseval.readthedocs.io/en/stable/
+repo_name: parameterlab/maseval
+repo_url: https://github.com/parameterlab/maseval
+edit_uri: edit/main/docs/
 
 theme:
   name: material
   logo: assets/logo-short.svg
+  favicon: assets/favicon.svg
   palette:
-    primary: teal
-    accent: teal
+    # Light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: teal
+      accent: teal
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    # Dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: teal
+      accent: teal
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
   features:
     - navigation.sections
     - content.code.copy
+
 extra_css:
   - css/mkdocstrings.css