Add review page

Signed-off-by: Mike McKiernan <[email protected]>

Author: mikemckiernan

Makefile

@@ -21,7 +21,7 @@ test_coverage:
 test_profile:
 	poetry run pytest -vv tests/ --profile-svg
 
-docs: docs-guardrails docs-community docs-colang
+docs: docs-guardrails docs-community docs-colang docs-review
 
 docs-guardrails:
 	poetry run sphinx-build -b html docs _build/docs/guardrails
@@ -32,6 +32,9 @@ docs-community:
 docs-colang:
 	poetry run sphinx-build -b html docs/colang _build/docs/colang
 
+docs-review:
+	poetry run sphinx-build -b html docs/review _build/docs
+
 pre_commit:
 	pre-commit install
 	pre-commit run --all-files

docs/review/conf.py

@@ -0,0 +1,90 @@
+# SPDX-FileCopyrightText: Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Copyright (c) 2024, NVIDIA CORPORATION.
+
+from datetime import date
+from pathlib import Path
+
+from toml import load
+
+project = "NeMo Guardrails Product Documentation"
+this_year = date.today().year
+copyright = f"2023-{this_year}, NVIDIA Corporation"
+author = "NVIDIA Corporation"
+release = "0.0.0"
+
+with open(
+    Path(__file__).parent.parent.parent / "pyproject.toml", encoding="utf-8"
+) as f:
+    t = load(f)
+    release = t.get("tool").get("poetry").get("version")
+
+extensions = [
+    "myst_parser",
+    "sphinx.ext.intersphinx",
+    "sphinx_copybutton",
+    "sphinx_reredirects",
+    "sphinx_design",
+]
+
+copybutton_exclude = ".linenos, .gp, .go"
+
+myst_linkify_fuzzy_links = False
+myst_heading_anchors = 3
+myst_enable_extensions = [
+    "deflist",
+    "dollarmath",
+    "fieldlist",
+    "substitution",
+    "colon_fence",
+]
+
+myst_substitutions = {
+    "version": release,
+}
+
+exclude_patterns = [
+    "_build/**",
+]
+
+# intersphinx_mapping = {
+#     'gpu-op': ('https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest', None),
+# }
+
+# suppress_warnings = ["etoc.toctree", "myst.header", "misc.highlighting_failure"]
+
+html_theme = "nvidia_sphinx_theme"
+html_copy_source = False
+html_show_sourcelink = False
+html_show_sphinx = False
+
+html_domain_indices = False
+html_use_index = False
+html_extra_path = ["project.json", "versions1.json"]
+highlight_language = "console"
+
+html_theme_options = {
+    "icon_links": [],
+    "switcher": {
+        "json_url": "../versions1.json",
+        "version_match": release,
+    },
+    "secondary_sidebar_items": [],
+    "primary_sidebar_end": [],
+}
+html_sidebars = {"**": []}
+
+html_baseurl = "https://docs.nvidia.com/nemo/guardrails/community/latest/"

docs/review/index.md

@@ -0,0 +1,23 @@
+# NVIDIA NeMo Guardrails Product Documentation
+
+::::{grid} 1 1 2 3
+
+:::{grid-item-card} {octicon}`shield-check;1.5em;sd-mr-1` NeMo Guardrails
+:link: ./guardrails/index.html
+
+Add safety checks to LLM-based applications between the application code and the LLM.
+:::
+
+:::{grid-item-card} {octicon}`plug;1.5em;sd-mr-1` Community Integrations
+:link: ./community/index.html
+
+Use popular safety checks with your NeMo Guardrails implementation.
+:::
+
+:::{grid-item-card} {octicon}`code;1.5em;sd-mr-1` Colang Developer Guide
+:link: ./colang/index.html
+
+Develop custom safety checks for conversational systems.
+:::
+
+::::

poetry.lock

@@ -171,6 +171,7 @@ sphinx = "<=7.5"
 myst-parser = "<=5"
 sphinx-copybutton = "<=0.6"
 nvidia-sphinx-theme = { version = ">=0.0.8", python = ">=3.10" }
+sphinx-design = "^0.6.1"
 
 
 [tool.pytest.ini_options]