Added doc homepage

docs/src/_static/_css/custom.css

@@ -0,0 +1,53 @@
+/* Override some aspects of the pydata-sphinx-theme */
+
+:root {
+  /* Use softer blue from bootstrap's default info color */
+  --pst-color-info: 23, 162, 184;
+}
+
+table {
+  width: auto; /* Override fit-content which breaks Styler user guide ipynb */
+}
+
+/* Main index page overview cards */
+
+.intro-card {
+  padding: 10px 10px 10px 10px;
+}
+
+.intro-card .sd-card-img-top {
+  margin: 10px;
+  height: 52px;
+  background: none !important;
+  position: relative;
+}
+
+.intro-card .sd-card-title {
+  color: var(--pst-color-primary);
+  font-size: var(--pst-font-size-h5);
+  padding: 0rem 0rem 0rem 0rem;
+}
+
+.intro-card .sd-card-footer {
+  border: none !important;
+}
+
+.intro-card .sd-card-footer p.sd-card-text {
+  max-width: 220px;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.intro-card .sd-btn-secondary {
+  background-color: #6c757d !important;
+  border-color: #6c757d !important;
+}
+
+.intro-card .sd-btn-secondary:hover {
+  background-color: #5a6268 !important;
+  border-color: #545b62 !important;
+}
+
+.card, .card img {
+  background-color: var(--pst-color-background);
+}

docs/src/conf.py

@@ -8,6 +8,9 @@ https://www.sphinx-doc.org/en/master/usage/configuration.html
 # -- Path setup --------------------------------------------------------------
 import os
 import sys
+import inspect
+import warnings
+
 from pathlib import Path
 from typing import Any, Dict
 
@@ -33,6 +36,12 @@ extensions = [
     "sphinx.ext.viewcode",
     "sphinx.ext.intersphinx",
     "sphinx.ext.graphviz",
+    "sphinx.ext.linkcode",
+    "sphinx.ext.coverage",
+    "sphinx.ext.doctest",
+    "sphinx.ext.extlinks",
+    "sphinx.ext.ifconfig",
+    "sphinx.ext.mathjax",
     "sphinxext.rediraffe",
     "sphinx_design",
     "sphinx_copybutton",
@@ -207,7 +216,9 @@ html_context = {
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
-html_css_files = ["custom.css"]
+html_css_files = [
+    "_css/custom.css",
+]
 html_js_files = ["custom-icons.js"]
 todo_include_todos = True
 
@@ -245,6 +256,65 @@ favicons = [
 
 # -- application setup -------------------------------------------------------
 
+# based on numpy doc/source/conf.py
+def linkcode_resolve(domain, info) -> str | None:
+    """
+    Determine the URL corresponding to Python object
+    """
+    if domain != "py":
+        return None
+
+    modname = info["module"]
+    fullname = info["fullname"]
+
+    submod = sys.modules.get(modname)
+    if submod is None:
+        return None
+
+    obj = submod
+    for part in fullname.split("."):
+        try:
+            with warnings.catch_warnings():
+                # Accessing deprecated objects will generate noisy warnings
+                warnings.simplefilter("ignore", FutureWarning)
+                obj = getattr(obj, part)
+        except AttributeError:
+            return None
+
+    try:
+        fn = inspect.getsourcefile(inspect.unwrap(obj))
+    except TypeError:
+        try:  # property
+            fn = inspect.getsourcefile(inspect.unwrap(obj.fget))
+        except (AttributeError, TypeError):
+            fn = None
+    if not fn:
+        return None
+
+    try:
+        source, lineno = inspect.getsourcelines(obj)
+    except TypeError:
+        try:  # property
+            source, lineno = inspect.getsourcelines(obj.fget)
+        except (AttributeError, TypeError):
+            lineno = None
+    except OSError:
+        lineno = None
+
+    if lineno:
+        linespec = f"#L{lineno}-L{lineno + len(source) - 1}"
+    else:
+        linespec = ""
+
+    fn = os.path.relpath(fn, start=os.path.dirname(openfactcheck.__file__))
+
+    if "+" in openfactcheck.__version__:
+        return f"https://github.com/hasaniqbal777/openfactcheck/blob/main/openfactcheck/{fn}{linespec}"
+    else:
+        return (
+            f"https://github.com/hasaniqbal777/openfactcheck/blob/"
+            f"v{openfactcheck.__version__}/openfactcheck/{fn}{linespec}"
+        )
 
 def setup_to_main(
     app: Sphinx, pagename: str, templatename: str, context, doctree

docs/src/development/index.md

@@ -0,0 +1 @@
+# Development

docs/src/getting_started/index.md

@@ -0,0 +1 @@
+# Getting Started

docs/src/index.md

@@ -9,28 +9,121 @@ html_theme.sidebar_secondary.remove: true
 
 # OpenFactCheck Documentation
 
-OpenFactCheck is an open source, Apache-licensed library designed to facilitate the evaluation and enhancement of factuality in responses generated by large language models (LLMs).
+```{eval-rst}
+.. module:: openfactcheck
+```
 
-## Installation
+OpenFactCheck is an open source, Apache-licensed library designed to facilitate the evaluation and enhancement of factuality in responses generated by large language models (LLMs).
 
-To install OpenFactCheck, run the following command:
+The design of {mod}`openfactcheck` emphasizes two principles:
 
-## Usage
+- Customizability and extensibility for both users and developers
+- Compatibility with existing methods and datasets
 
-The usage of OpenFactCheck is documented below.
+It consists of three core modules:
 
-```{toctree}
-:maxdepth: 2
+```{gallery-grid}
+:grid-columns: 1 1 2 3
 
-Usage <usage/index>
+- header: "{fas}`check-to-slot;pst-color-primary`  Response Evaluator"
+  content: "Customizes an automatic fact-checker to verify free-form documents, providing detailed reports on the factuality of the responses."
+- header: "{fas}`chart-line;pst-color-primary`  LLM Evaluator"
+  content: "Applies factuality-specific benchmarks to assess the factual performance of large language models, providing detailed reports on the factuality of the responses."
+- header: "{fas}`trophy;pst-color-primary`  Fact Checker Evaluator"
+  content: "Evaluates fact-checking accuracy, featuring a leaderboard that ranks systems by precision, speed, and cost, driving innovation in automatic fact-checking."
 ```
 
-## API
+Explore the documentation to learn more about the library, its features, how to use and contribute to it, and more.
+
+```{eval-rst}
+.. grid:: 1 2 2 2
+    :gutter: 4
+    :padding: 2 2 0 0
+    :class-container: sd-text-center
+
+    .. grid-item-card:: Getting Started
+        :img-top: _static/index_getting_started.svg
+        :class-card: intro-card
+        :shadow: md
+
+        New to *OpenFactCheck*? Check out the getting started guides. They contain an
+        introduction to *OpenFactCheck*'s main concepts and links to additional tutorials.
+
+        +++
+        
+        .. button-ref:: getting_started/index
+            :ref-type: doc
+            :color: secondary
+            :expand:
+
+            Begin Your Journey
+
+    .. grid-item-card::  User Guide
+        :img-top: _static/index_user_guide.svg
+        :class-card: intro-card
+        :shadow: md
+
+        The user guide provides in-depth information on the
+        key concepts of *OpenFactCheck* with useful background information and explanation.
+
+        +++
+
+        .. button-ref:: user_guide/index
+            :ref-type: doc
+            :color: secondary
+            :expand:
 
-The content of the exposed `openfactcheck` API is documented below.
+            View User Guide
+
+    .. grid-item-card::  API Reference
+        :img-top: _static/index_api.svg
+        :class-card: intro-card
+        :shadow: md
+
+        The reference guide contains a detailed description of
+        the *OpenFactCheck* API. The reference describes how the methods work and which parameters can
+        be used. It assumes that you have an understanding of the key concepts.
+
+        +++
+
+        .. button-ref:: api/index
+            :ref-type: doc
+            :color: secondary
+            :expand:
+
+            View API Reference
+
+    .. grid-item-card::  Developer Guide
+        :img-top: _static/index_contribute.svg
+        :class-card: intro-card
+        :shadow: md
+
+        Want to improve existing functionalities? Saw a typo in the documentation?
+        Want to contribute to the project? The contributing guidelines will guide
+        you through the process of improving *OpenFactCheck*.
+
+        +++
+
+        .. button-ref:: development/index
+            :ref-type: doc
+            :color: secondary
+            :expand:
+
+            Contribute
+```
+
+**Useful links**:
+[Binary Installers](https://pypi.org/project/openfactcheck) |
+[Source Repository](https://github.com/hasaniqbal777/openfactcheck) |
+[Issues & Ideas](https://github.com/hasaniqbal777/openfactcheck/issues) |
 
 ```{toctree}
-:maxdepth: 2
+:hidden: true
+:maxdepth: 3
+:titlesonly: true
 
-API <api/index>
-```
+getting_started/index
+user_guide/index
+api/index
+development/index
+```

docs/src/usage/index.md

@@ -1 +0,0 @@
-# Usage

docs/src/user_guide/index.md

@@ -0,0 +1,2 @@
+# User Guide
+