[DOCS] Redo(#149): Add config, documentation, and github workflow for mkdocs

.github/workflows/docs.yml

@@ -0,0 +1,76 @@
+# see: https://github.com/marketplace/actions/deploy-mkdocs
+name: Publish docs via GitHub Pages
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - closed
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+    inputs:
+      deploy_to:
+        description: "Deployment destination"
+        type: choice
+        options:
+          - prod
+          - preview
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pages: write
+      id-token: write
+      pull-requests: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          # ✅ Explicitly checkout the PR branch
+          ref: ${{ github.event.pull_request.head.sha }}
+      - name: Build
+        uses: Tiryoh/actions-mkdocs@v0.24.0
+        if: github.event.action != 'closed'
+        with:
+          # mkdocs_version: 'latest' # option
+          #mkdocs_version: '1.1' # option
+          requirements: "requirements-mkdocs.txt" # option
+          configfile: "mkdocs.yml" # option
+      - name: Fix site permissions
+        if: github.event.action != 'closed'
+        run: |
+          sudo chown -R runner:runner site/
+          find site/ -type f -exec chmod 644 {} \;
+          find site/ -type d -exec chmod 755 {} \;
+      - uses: rossjrw/pr-preview-action@v1
+        if: github.event_name == 'pull_request' || (github.event_name == 'workflow_dispatch' && inputs.deploy_to == 'preview')
+        with:
+          source-dir: ./site/
+          preview-branch: gh-pages
+          umbrella-dir: pr-preview
+          action: auto
+      - uses: JamesIves/github-pages-deploy-action@v4
+        if: (github.event_name == 'push' && github.ref_name == 'main') ||  (github.event_name == 'workflow_dispatch' && inputs.deploy_to == 'prod')
+        with:
+          folder: ./site/
+          branch: gh-pages
+          clean-exclude: pr-preview
+          force: false
+
+      # - name: Deploy docs
+      #   uses: mhausenblas/mkdocs-deploy-gh-pages@master
+      #   # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
+      #   env:
+      #     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      #     #CUSTOM_DOMAIN: optionaldomain.com
+      #     CONFIG_FILE: mkdocs.yml
+      #     EXTRA_PACKAGES: build-base
+      #     # GITHUB_DOMAIN: github.myenterprise.com
+      #     REQUIREMENTS: requirements-mkdocs.txt

.gitignore

@@ -4,6 +4,7 @@ __private__
 /build
 /dist
 /analysis_outputs
+/site
 VERSION
 *.DS_Store
 .env*

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/psf/black
+    rev: 23.9.1
+    hooks:
+      - id: black

.python-version

@@ -0,0 +1 @@
+3.12.10

README.md

@@ -1,4 +1,21 @@
-# mango-tango-cli: A python terminal wrapper for CIB Mango Tree analyzers
+<h2 align="center">mango-tango-cli</h2>
+<h3 align="center">A Python command-line tool for detecting coordinated inauthentic behavior</h3>
+
+<p align="center">
+<img src="https://raw.githubusercontent.com/CIB-Mango-Tree/CIB-Mango-Tree-Website/main/assets/images/mango-text.PNG" alt="Mango logo" style="width:200px;"/>
+</p>
+
+<p align="center">
+<a href="https://www.python.org/"><img alt="code" src="https://img.shields.io/badge/code-Python%203.12-blue?logo=Python"></a>
+<a href="https://black.readthedocs.io/en/stable/"><img alt="style: black" src="https://img.shields.io/badge/style-Black-black?logo=Black"></a>
+<a href="https://docs.astral.sh/ruff/"><img alt="style: black" src="https://img.shields.io/badge/tool-Polars-skyblue?logo=Polars"></a>
+</p>
+
+---
+
+## Technical Documentation
+
+For in-depth technical docs related to this repository please visit [https://civictechdc.github.io/mango-tango-cli](https://civictechdc.github.io/mango-tango-cli)
 
 ## Requirements
 

analyzer_interface/context.py

@@ -166,17 +166,44 @@ def parquet_path(self) -> str:
 
 
 class ShinyContext(BaseModel):
+    """
+    Output interface for Shiny dashboards
+    """
+
     panel: NavPanel = None
+    """
+    UI navigation panel to be added to shiny dashboard
+    """
+
     server_handler: Optional[ServerCallback] = None
+    """
+    Server handler callback to be called by the shiny application instance
+    """
 
     class Config:
         arbitrary_types_allowed = True
 
 
 class FactoryOutputContext(BaseModel):
+    """
+    Output interface for both factory and api_facotry functions for web
+    presenters.
+    """
+
     shiny: Optional[ShinyContext] = None
+    """
+    Factory oputput for shiny dashboards
+    """
+
     api: Optional[dict[str, Any]] = None
+    """
+    API factory output for React dashboard REST API
+    """
+
     data_frames: Optional[dict[str, DataFrame]] = None
+    """
+    API factory dataframe output for React dashboard REST API
+    """
 
     class Config:
         arbitrary_types_allowed = True