Added to docs

hrushikeshrv · Jan 30, 2023 · 50e0721 · 50e0721
1 parent 9774588
commit 50e0721
Show file tree

Hide file tree

Showing 27 changed files with 166 additions and 87 deletions.
diff --git a/chessengine/utils.py b/chessengine/utils.py
@@ -105,7 +105,7 @@ def clear_lines(n: int) -> None:
 
 def change_turn(side_to_move: str) -> str:
     """
-    Returns "black" if side_to_move is "white", and "white" otherwise.
+    Returns "black" if ``side_to_move`` is "white", and "white" otherwise.
 
     :param side_to_move: The current side
     """

diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/ref/chessengine.bitboard.doctree b/docs/_build/doctrees/ref/chessengine.bitboard.doctree
diff --git a/docs/_build/doctrees/ref/chessengine.moves.doctree b/docs/_build/doctrees/ref/chessengine.moves.doctree
diff --git a/docs/_build/doctrees/ref/chessengine.utils.doctree b/docs/_build/doctrees/ref/chessengine.utils.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +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: 3ff6f3f857ba0379aaf1dace8b5e8b60
+config: b170a29c9d5c6beebdc014c42bee8a07
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_sources/ref/chessengine.utils.rst.txt b/docs/_build/html/_sources/ref/chessengine.utils.rst.txt
@@ -12,3 +12,7 @@
 .. autofunction:: lsb_pos
 
 .. autofunction:: clear_lines
+
+.. autofunction:: change_turn
+
+.. autofunction:: score_from_move
diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.3.1',
+    VERSION: '0.3.2',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/_build/html/api.html b/docs/_build/html/api.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="chessengine.bitboard" href="ref/chessengine.bitboard.html" /><link rel="prev" title="Welcome to chessengine’s documentation!" href="index.html" />
 
     <meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/>
-        <title>API Reference - chessengine 0.3.1 documentation</title>
+        <title>API Reference - chessengine 0.3.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@@ -123,7 +123,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">chessengine 0.3.1 documentation</div></a>
+      <a href="index.html"><div class="brand">chessengine 0.3.2 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -146,7 +146,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
 
 
-  <span class="sidebar-brand-text">chessengine 0.3.1 documentation</span>
+  <span class="sidebar-brand-text">chessengine 0.3.2 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

diff --git a/docs/_build/html/chessboard.html b/docs/_build/html/chessboard.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Usage &amp; Installation" href="usage.html" /><link rel="prev" title="chessengine.pgn.parser" href="ref/chessengine.pgn.parser.html" />
 
     <meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/>
-        <title>Internal Board Representation - chessengine 0.3.1 documentation</title>
+        <title>Internal Board Representation - chessengine 0.3.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@@ -123,7 +123,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">chessengine 0.3.1 documentation</div></a>
+      <a href="index.html"><div class="brand">chessengine 0.3.2 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -146,7 +146,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
 
 
-  <span class="sidebar-brand-text">chessengine 0.3.1 documentation</span>
+  <span class="sidebar-brand-text">chessengine 0.3.2 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

diff --git a/docs/_build/html/contributing.html b/docs/_build/html/contributing.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="Playing A Game" href="playing.html" />
 
     <meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/>
-        <title>Contributing A Patch - chessengine 0.3.1 documentation</title>
+        <title>Contributing A Patch - chessengine 0.3.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@@ -123,7 +123,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">chessengine 0.3.1 documentation</div></a>
+      <a href="index.html"><div class="brand">chessengine 0.3.2 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -146,7 +146,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
 
 
-  <span class="sidebar-brand-text">chessengine 0.3.1 documentation</span>
+  <span class="sidebar-brand-text">chessengine 0.3.2 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -4,7 +4,7 @@
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" />
 
-    <meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/><title>Index - chessengine 0.3.1 documentation</title>
+    <meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/><title>Index - chessengine 0.3.2 documentation</title>
 <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@@ -121,7 +121,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">chessengine 0.3.1 documentation</div></a>
+      <a href="index.html"><div class="brand">chessengine 0.3.2 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -144,7 +144,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
 
 
-  <span class="sidebar-brand-text">chessengine 0.3.1 documentation</span>
+  <span class="sidebar-brand-text">chessengine 0.3.2 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@@ -203,7 +203,7 @@
 
 <section class="genindex-section">
   <h1 id="index">Index</h1>
-  <div class="genindex-jumpbox"><a href="#_"><strong>_</strong></a> | <a href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#H"><strong>H</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#U"><strong>U</strong></a></div>
+  <div class="genindex-jumpbox"><a href="#_"><strong>_</strong></a> | <a href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#H"><strong>H</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#U"><strong>U</strong></a></div>
 </section>
 <section id="_" class="genindex-section">
   <h2>_</h2>
@@ -261,6 +261,8 @@ <h2>B</h2>
   <h2>C</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
     <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="ref/chessengine.utils.html#chessengine.utils.change_turn">change_turn() (in module chessengine.utils)</a>
+</li>
         <li>
     chessengine.bitboard
 
@@ -292,6 +294,16 @@ <h2>C</h2>
   </tr></table>
 </section>
 
+<section id="E" class="genindex-section">
+  <h2>E</h2>
+  <table style="width: 100%" class="indextable genindextable"><tr>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="ref/chessengine.bitboard.html#chessengine.bitboard.Board.evaluate_score">evaluate_score() (chessengine.bitboard.Board method)</a>
+</li>
+    </ul></td>
+  </tr></table>
+</section>
+
 <section id="G" class="genindex-section">
   <h2>G</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
@@ -453,10 +465,12 @@ <h2>P</h2>
   <h2>S</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
     <td style="width: 33%; vertical-align: top;"><ul>
-        <li><a href="ref/chessengine.bitboard.html#chessengine.bitboard.Board.search_forward">search_forward() (chessengine.bitboard.Board method)</a>
+        <li><a href="ref/chessengine.utils.html#chessengine.utils.score_from_move">score_from_move() (in module chessengine.utils)</a>
 </li>
     </ul></td>
     <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="ref/chessengine.bitboard.html#chessengine.bitboard.Board.search_forward">search_forward() (chessengine.bitboard.Board method)</a>
+</li>
         <li><a href="ref/chessengine.bitboard.html#chessengine.bitboard.Board.set_bitboard">set_bitboard() (chessengine.bitboard.Board method)</a>
 </li>
     </ul></td>

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="API Reference" href="api.html" />
 
     <meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/>
-        <title>chessengine 0.3.1 documentation</title>
+        <title>chessengine 0.3.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@@ -123,7 +123,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="#"><div class="brand">chessengine 0.3.1 documentation</div></a>
+      <a href="#"><div class="brand">chessengine 0.3.2 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -146,7 +146,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="#">
 
 
-  <span class="sidebar-brand-text">chessengine 0.3.1 documentation</span>
+  <span class="sidebar-brand-text">chessengine 0.3.2 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
diff --git a/docs/_build/html/playing.html b/docs/_build/html/playing.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Contributing A Patch" href="contributing.html" /><link rel="prev" title="Usage &amp; Installation" href="usage.html" />
 
     <meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/>
-        <title>Playing A Game - chessengine 0.3.1 documentation</title>
+        <title>Playing A Game - chessengine 0.3.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@@ -123,7 +123,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">chessengine 0.3.1 documentation</div></a>
+      <a href="index.html"><div class="brand">chessengine 0.3.2 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -146,7 +146,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
 
 
-  <span class="sidebar-brand-text">chessengine 0.3.1 documentation</span>
+  <span class="sidebar-brand-text">chessengine 0.3.2 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html
@@ -4,7 +4,7 @@
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
 
-    <meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/><title>Python Module Index - chessengine 0.3.1 documentation</title>
+    <meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/><title>Python Module Index - chessengine 0.3.2 documentation</title>
 <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@@ -121,7 +121,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">chessengine 0.3.1 documentation</div></a>
+      <a href="index.html"><div class="brand">chessengine 0.3.2 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -144,7 +144,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
 
 
-  <span class="sidebar-brand-text">chessengine 0.3.1 documentation</span>
+  <span class="sidebar-brand-text">chessengine 0.3.2 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">