DOC: update development documentation fcad65c

ansys · Nov 30, 2023 · 87921a8 · 87921a8
commit 87921a8
Show file tree

Hide file tree

Showing 400 changed files with 64,635 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/CNAME b/CNAME
@@ -0,0 +1 @@
+review-bot.docs.pyansys.com
diff --git a/index.html b/index.html
@@ -0,0 +1,6 @@
+<!DOCTYPE html>
+<meta charset="utf-8">
+<title>Redirecting to https://review-bot.docs.pyansys.com/version/stable/</title>
+<meta name="description" content="">
+<meta http-equiv="refresh" content="0; URL=https://review-bot.docs.pyansys.com/version/stable/">
+<link rel="canonical" href="https://review-bot.docs.pyansys.com/version/stable/">
diff --git a/sitemap.xml b/sitemap.xml
@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+  <url>
+    <loc>https://review-bot.docs.pyansys.com</loc>
+    <lastmod>2023-11-20T08:37:51+00:00</lastmod>
+    <changefreq>daily</changefreq>
+    <priority>1.0</priority>
+  </url>
+  <url>
+    <loc>https://review-bot.docs.pyansys.comversion/stable/search</loc>
+    <lastmod>2023-11-20T08:37:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://review-bot.docs.pyansys.comversion/stable/autoapi/review/bot/misc/index</loc>
+    <lastmod>2023-11-20T08:37:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://review-bot.docs.pyansys.comversion/stable/autoapi/review/bot/defaults/index</loc>
+    <lastmod>2023-11-20T08:37:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://review-bot.docs.pyansys.comversion/stable/autoapi/review/bot/open_ai_interface/index</loc>
+    <lastmod>2023-11-20T08:37:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://review-bot.docs.pyansys.comversion/stable/autoapi/review/bot/index</loc>
+    <lastmod>2023-11-20T08:37:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://review-bot.docs.pyansys.comversion/stable/autoapi/review/bot/exceptions/index</loc>
+    <lastmod>2023-11-20T08:37:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://review-bot.docs.pyansys.comversion/stable/autoapi/review/bot/git_interface/index</loc>
+    <lastmod>2023-11-20T08:37:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://review-bot.docs.pyansys.comversion/stable/autoapi/review/bot/schema/index</loc>
+    <lastmod>2023-11-20T08:37:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://review-bot.docs.pyansys.comversion/stable/autoapi/review/bot/schema/schema/index</loc>
+    <lastmod>2023-11-20T08:37:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://review-bot.docs.pyansys.comversion/stable/autoapi/review/bot/cli/index</loc>
+    <lastmod>2023-11-20T08:37:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://review-bot.docs.pyansys.comversion/stable/autoapi/review/bot/cli/cli/index</loc>
+    <lastmod>2023-11-20T08:37:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://review-bot.docs.pyansys.comversion/stable/autoapi/review/bot/gh_interface/index</loc>
+    <lastmod>2023-11-20T08:37:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://review-bot.docs.pyansys.comversion/stable/autoapi/index</loc>
+    <lastmod>2023-11-20T08:37:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://review-bot.docs.pyansys.comversion/stable/genindex</loc>
+    <lastmod>2023-11-20T08:37:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://review-bot.docs.pyansys.comversion/stable/py-modindex</loc>
+    <lastmod>2023-11-20T08:37:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://review-bot.docs.pyansys.comversion/stable/_static/webpack-macros</loc>
+    <lastmod>2023-11-20T08:37:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://review-bot.docs.pyansys.comversion/stable/index</loc>
+    <lastmod>2023-11-20T08:37:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+</urlset>
diff --git a/version/0.1/.buildinfo b/version/0.1/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 1bd4e7504da201b678dfdbbe84116987
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/version/0.1/_sources/autoapi/index.rst.txt b/version/0.1/_sources/autoapi/index.rst.txt
@@ -0,0 +1,9 @@
+API reference
+=============
+
+This page contains the ``review-bot`` API reference.
+
+.. toctree::
+   :titlesonly:
+
+   /autoapi/review/bot/index
diff --git a/version/0.1/_sources/autoapi/review/bot/cli/cli/index.rst.txt b/version/0.1/_sources/autoapi/review/bot/cli/cli/index.rst.txt
@@ -0,0 +1,77 @@
+:py:mod:`review.bot.cli.cli`
+============================
+
+.. py:module:: review.bot.cli.cli
+
+.. autoapi-nested-parse::
+
+   Module for CLI related code.
+
+   ..
+       !! processed by numpydoc !!
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   review.bot.cli.cli.show_review
+   review.bot.cli.cli.main
+
+
+
+.. py:function:: show_review(args)
+
+   
+   Show through command line the review of the diff from the LLM.
+
+
+   :Parameters:
+
+       **args**
+           Args from the command line.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+
+.. py:function:: main()
+
+   
+   Entrypoint to execute.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+
diff --git a/version/0.1/_sources/autoapi/review/bot/cli/index.rst.txt b/version/0.1/_sources/autoapi/review/bot/cli/index.rst.txt
@@ -0,0 +1,38 @@
+:py:mod:`review.bot.cli`
+========================
+
+.. py:module:: review.bot.cli
+
+.. autoapi-nested-parse::
+
+
+   Module for CLI interface.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+
+
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   cli/index.rst
+
+
diff --git a/version/0.1/_sources/autoapi/review/bot/defaults/index.rst.txt b/version/0.1/_sources/autoapi/review/bot/defaults/index.rst.txt
@@ -0,0 +1,142 @@
+:py:mod:`review.bot.defaults`
+=============================
+
+.. py:module:: review.bot.defaults
+
+.. autoapi-nested-parse::
+
+   Default variables for the project.
+
+   ..
+       !! processed by numpydoc !!
+
+
+Module Contents
+---------------
+
+.. py:data:: ACCESS_TOKEN
+
+   
+   Default OpenAI token to use.
+
+   Get the OpenAI token from the environment variables.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+
+.. py:data:: API_BASE
+
+   
+   Default URL for OpenAI Azure API.
+
+   Get the URL of the OpenAI Azure service from the
+   environment variables.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+
+.. py:data:: API_TYPE
+
+   
+   Default OpenAI API type.
+
+   Get the type of OpenAI API we are using from the
+   environment variables.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+
+.. py:data:: API_MODEL
+
+   
+   Default OpenAI Model to use.
+
+   Get the type of OpenAI model we are using from the
+   environment variables. In Azure dependes on the
+   service you have available.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+
+.. py:data:: API_VERSION
+
+   
+   Default OpenAI API Azure version we are using.
+
+   Get the OpenAI API Azure version from the environment variables.
+   You can check available versions in this link:
+   https://learn.microsoft.com/en-us/azure/cognitive-services/openai/reference#rest-api-versioning
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+