docs: Read the docs website for AGC (#114)

* created documentation for agc.readthedocs.io website
* includes AGC overview dataset & analysis details, ML task description

.github/workflows/CI.yml

@@ -0,0 +1,18 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Build docs with sphinx
+        run: |
+          pip install -r docs/requirements.txt
+          sphinx-build docs docs/_build

.readthedocs.yaml

@@ -0,0 +1,15 @@
+version: 2
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "3.8"
+
+sphinx:
+  configuration: docs/conf.py
+
+formats: all

docs/atlas-open-data-hzz

@@ -0,0 +1 @@
+../analyses/atlas-open-data-hzz/

docs/cms-open-data-ttbar

@@ -0,0 +1 @@
+../analyses/cms-open-data-ttbar/

docs/conf.py

@@ -0,0 +1,81 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+from __future__ import annotations
+
+# -- Project information -----------------------------------------------------
+
+project = "Analysis Grand Challenge"
+authors = ["Alexander Held", "Oksana Shadura", "Elliott Kauffman"]
+version = "0.2.0"
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "myst_parser",
+    "nbsphinx",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.napoleon",
+    "sphinx_copybutton",
+    "sphinxcontrib.programoutput",
+             ]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = [
+    "_build",
+    "**.ipynb_checkpoints",
+    ".DS_Store",
+    ".env",
+]
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_book_theme"
+
+# Config for the Sphinx book
+
+html_baseurl = "https://agc.readthedocs.io/en/latest/"
+
+html_theme_options = {
+    "home_page_in_toc": True,
+    "repository_url": "https://github.com/iris-hep/analysis-grand-challenge",
+    "use_repository_button": True,
+    "use_issues_button": True,
+    "use_edit_page_button": True,
+}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# 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: list[str] = []
+
+# -- Options for Notebook input ----------------------------------------------
+
+html_logo = "pipeline.png"
+html_title = f"Analysis Grand Challenge {version}"
+
+nbsphinx_execute = "auto"  # auto, never
+
+highlight_language = "python3"
+
+nbsphinx_execute_arguments = [
+    "--InlineBackend.figure_formats={'png2x'}",
+    "--InlineBackend.rc=figure.dpi=96",
+]
+
+nbsphinx_kernel_name = "python3"