diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index c0dbd7b6ace3330746c1b912db0d6937796362c7..2cad4ec42c4cece05226905b251398b0a7720fa5 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -40,7 +40,7 @@ include: # # Case 5 Docs # # stages: code_quality, build, deploy # - local: ci-configs/case-5-docs/lint_docs.yml -# - local: ci-configs/case-5-docs/generate_docs.yml +- local: ci-configs/case-5-docs/generate_docs.yml - local: ci-configs/case-5-docs/pages.yml diff --git a/case-5-docs/.gitkeep b/case-5-docs/.gitkeep deleted file mode 100644 index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..0000000000000000000000000000000000000000 diff --git a/case-5-docs/README.rst b/case-5-docs/README.rst new file mode 100644 index 0000000000000000000000000000000000000000..48bf455874a78481bd70b3b4c9345ffab65d3aee --- /dev/null +++ b/case-5-docs/README.rst @@ -0,0 +1,5 @@ +Lumache +======= + +**Lumache** (/lu'make/) is a Python library for cooks and food lovers that +creates recipes mixing random ingredients. \ No newline at end of file diff --git a/case-5-docs/docs/build/doctrees/environment.pickle b/case-5-docs/docs/build/doctrees/environment.pickle index 98dcfb4e0768d6531ddf1802bb1a4bff88d38cd7..31cb434e6c82ebaecbf14dc576c0dd2829b80a70 100644 Binary files a/case-5-docs/docs/build/doctrees/environment.pickle and b/case-5-docs/docs/build/doctrees/environment.pickle differ diff --git a/case-5-docs/docs/build/doctrees/index.doctree b/case-5-docs/docs/build/doctrees/index.doctree index 0cf115738db378511b4680bf9f8043da6d220222..1899c32a5c3b9f9f471520029d5fd9d2f4d27e5e 100644 Binary files a/case-5-docs/docs/build/doctrees/index.doctree and b/case-5-docs/docs/build/doctrees/index.doctree differ diff --git a/case-5-docs/docs/build/doctrees/math_operations.doctree b/case-5-docs/docs/build/doctrees/math_operations.doctree new file mode 100644 index 0000000000000000000000000000000000000000..820f9716290b4c30ef7c03905d57460e1fdac4e6 Binary files /dev/null and b/case-5-docs/docs/build/doctrees/math_operations.doctree differ diff --git a/case-5-docs/docs/build/doctrees/modules.doctree b/case-5-docs/docs/build/doctrees/modules.doctree new file mode 100644 index 0000000000000000000000000000000000000000..1dc285c99019a04b7d4339df4534f8adfd60e120 Binary files /dev/null and b/case-5-docs/docs/build/doctrees/modules.doctree differ diff --git a/case-5-docs/docs/build/doctrees/string_operators.doctree b/case-5-docs/docs/build/doctrees/string_operators.doctree new file mode 100644 index 0000000000000000000000000000000000000000..6590a64b2a52d22337b41617f4251c6a879b3969 Binary files /dev/null and b/case-5-docs/docs/build/doctrees/string_operators.doctree differ diff --git a/case-5-docs/docs/build/html/.buildinfo b/case-5-docs/docs/build/html/.buildinfo index 9ea9b0730b74cbd24550262afa50d2eb21e2051b..1a23297260a4899de493fdce67cadf6fbc9c83ea 100644 --- a/case-5-docs/docs/build/html/.buildinfo +++ b/case-5-docs/docs/build/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done. -config: a32352b8faa430ed85cf93d934744f43 +config: 19961433baf824ad1a6e7275ddd2b28b tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/case-5-docs/docs/build/html/.buildinfo.bak b/case-5-docs/docs/build/html/.buildinfo.bak new file mode 100644 index 0000000000000000000000000000000000000000..5b21876cb2e7c24ed2e24d3839b8da3657b41224 --- /dev/null +++ b/case-5-docs/docs/build/html/.buildinfo.bak @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file records the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 54d05628686093d9220e7209dab122b4 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/case-5-docs/docs/build/html/_modules/index.html b/case-5-docs/docs/build/html/_modules/index.html new file mode 100644 index 0000000000000000000000000000000000000000..8dff246eb3b1a470c579e31ce15c54bcb9ee1842 --- /dev/null +++ b/case-5-docs/docs/build/html/_modules/index.html @@ -0,0 +1,102 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" data-content_root="../"> +<head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>Overview: module code — The Wizzard Calc o.1 documentation</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + + + <script src="../_static/jquery.js?v=5d32c60e"></script> + <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> + <script src="../_static/documentation_options.js?v=f8b91ae0"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> + <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/js/theme.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../index.html" class="icon icon-home"> + The Wizzard Calc + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../modules.html">wizzard_code</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">The Wizzard Calc</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item active">Overview: module code</li> + <li class="wy-breadcrumbs-aside"> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <h1>All modules for which code is available</h1> +<ul><li><a href="math_operations.html">math_operations</a></li> +<li><a href="string_operators.html">string_operators</a></li> +</ul> + + </div> + </div> + <footer> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 2025, The Author.</p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html> \ No newline at end of file diff --git a/case-5-docs/docs/build/html/_modules/math_operations.html b/case-5-docs/docs/build/html/_modules/math_operations.html new file mode 100644 index 0000000000000000000000000000000000000000..c9e8dbc0144c66a72bc5d1af9adcce65ef4bffd7 --- /dev/null +++ b/case-5-docs/docs/build/html/_modules/math_operations.html @@ -0,0 +1,172 @@ +<!DOCTYPE html> + +<html lang="en" data-content_root="../"> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>math_operations — The Wizzard Calc o.1 documentation</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" /> + <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=12dfc556" /> + <script src="../_static/documentation_options.js?v=f8b91ae0"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> + <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + + <link rel="stylesheet" href="../_static/custom.css" type="text/css" /> + + + + + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <h1>Source code for math_operations</h1><div class="highlight"><pre> +<span></span><span class="sd">"""</span> +<span class="sd">This module contains basic mathematical operations.</span> +<span class="sd">"""</span> + +<div class="viewcode-block" id="add"> +<a class="viewcode-back" href="../math_operations.html#math_operations.add">[docs]</a> +<span class="k">def</span><span class="w"> </span><span class="nf">add</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">):</span> +<span class="w"> </span><span class="sd">"""</span> +<span class="sd"> Adds two numbers.</span> + +<span class="sd"> Parameters:</span> +<span class="sd"> a (int, float): The first number.</span> +<span class="sd"> b (int, float): The second number.</span> + +<span class="sd"> Returns:</span> +<span class="sd"> int, float: The sum of the two numbers.</span> +<span class="sd"> """</span> + <span class="k">return</span> <span class="n">a</span> <span class="o">+</span> <span class="n">b</span></div> + + +<div class="viewcode-block" id="subtract"> +<a class="viewcode-back" href="../math_operations.html#math_operations.subtract">[docs]</a> +<span class="k">def</span><span class="w"> </span><span class="nf">subtract</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">):</span> +<span class="w"> </span><span class="sd">"""</span> +<span class="sd"> Subtracts the second number from the first.</span> + +<span class="sd"> Parameters:</span> +<span class="sd"> a (int, float): The first number.</span> +<span class="sd"> b (int, float): The second number.</span> + +<span class="sd"> Returns:</span> +<span class="sd"> int, float: The difference between the two numbers.</span> +<span class="sd"> """</span> + <span class="k">return</span> <span class="n">a</span> <span class="o">-</span> <span class="n">b</span></div> + + +<div class="viewcode-block" id="multiply"> +<a class="viewcode-back" href="../math_operations.html#math_operations.multiply">[docs]</a> +<span class="k">def</span><span class="w"> </span><span class="nf">multiply</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">):</span> +<span class="w"> </span><span class="sd">"""</span> +<span class="sd"> Multiplies two numbers.</span> + +<span class="sd"> Parameters:</span> +<span class="sd"> a (int, float): The first number.</span> +<span class="sd"> b (int, float): The second number.</span> + +<span class="sd"> Returns:</span> +<span class="sd"> int, float: The product of the two numbers.</span> +<span class="sd"> """</span> + <span class="k">return</span> <span class="n">a</span> <span class="o">*</span> <span class="n">b</span></div> + + +<div class="viewcode-block" id="divide"> +<a class="viewcode-back" href="../math_operations.html#math_operations.divide">[docs]</a> +<span class="k">def</span><span class="w"> </span><span class="nf">divide</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">):</span> +<span class="w"> </span><span class="sd">"""</span> +<span class="sd"> Divides the first number by the second.</span> + +<span class="sd"> Parameters:</span> +<span class="sd"> a (int, float): The numerator.</span> +<span class="sd"> b (int, float): The denominator.</span> + +<span class="sd"> Returns:</span> +<span class="sd"> float: The quotient of the division.</span> + +<span class="sd"> Raises:</span> +<span class="sd"> ValueError: If the denominator is zero.</span> +<span class="sd"> """</span> + <span class="k">if</span> <span class="n">b</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> + <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"The denominator cannot be zero."</span><span class="p">)</span> + <span class="k">return</span> <span class="n">a</span> <span class="o">/</span> <span class="n">b</span></div> + +</pre></div> + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="Main"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="../index.html">The Wizzard Calc</a></h1> + + + + + + + + +<h3>Navigation</h3> +<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../modules.html">wizzard_code</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../index.html">Documentation overview</a><ul> + <li><a href="index.html">Module code</a><ul> + </ul></li> + </ul></li> +</ul> +</div> +<search id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="../search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> + <input type="submit" value="Go" /> + </form> + </div> +</search> +<script>document.getElementById('searchbox').style.display = "block"</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2025, The Author. + + | + Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a> + & <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a> + + </div> + + + + + </body> +</html> \ No newline at end of file diff --git a/case-5-docs/docs/build/html/_modules/string_operators.html b/case-5-docs/docs/build/html/_modules/string_operators.html new file mode 100644 index 0000000000000000000000000000000000000000..8b8f91731b28be64e80076d2c8f7d3f54e4471d9 --- /dev/null +++ b/case-5-docs/docs/build/html/_modules/string_operators.html @@ -0,0 +1,165 @@ +<!DOCTYPE html> + +<html lang="en" data-content_root="../"> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>string_operators — The Wizzard Calc o.1 documentation</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" /> + <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=12dfc556" /> + <script src="../_static/documentation_options.js?v=f8b91ae0"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> + <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + + <link rel="stylesheet" href="../_static/custom.css" type="text/css" /> + + + + + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <h1>Source code for string_operators</h1><div class="highlight"><pre> +<span></span><span class="sd">"""</span> +<span class="sd">This module contains basic string operations.</span> +<span class="sd">"""</span> + +<div class="viewcode-block" id="concatenate"> +<a class="viewcode-back" href="../string_operators.html#string_operators.concatenate">[docs]</a> +<span class="k">def</span><span class="w"> </span><span class="nf">concatenate</span><span class="p">(</span><span class="n">str1</span><span class="p">,</span> <span class="n">str2</span><span class="p">):</span> +<span class="w"> </span><span class="sd">"""</span> +<span class="sd"> Concatenates two strings.</span> + +<span class="sd"> Parameters:</span> +<span class="sd"> str1 (str): The first string.</span> +<span class="sd"> str2 (str): The second string.</span> + +<span class="sd"> Returns:</span> +<span class="sd"> str: The concatenation of the two strings.</span> +<span class="sd"> """</span> + <span class="k">return</span> <span class="n">str1</span> <span class="o">+</span> <span class="n">str2</span></div> + + +<div class="viewcode-block" id="reverse_string"> +<a class="viewcode-back" href="../string_operators.html#string_operators.reverse_string">[docs]</a> +<span class="k">def</span><span class="w"> </span><span class="nf">reverse_string</span><span class="p">(</span><span class="n">string</span><span class="p">):</span> +<span class="w"> </span><span class="sd">"""</span> +<span class="sd"> Reverses a given string.</span> + +<span class="sd"> Parameters:</span> +<span class="sd"> string (str): The string to reverse.</span> + +<span class="sd"> Returns:</span> +<span class="sd"> str: The reversed string.</span> +<span class="sd"> """</span> + <span class="k">return</span> <span class="n">string</span><span class="p">[::</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span></div> + + +<div class="viewcode-block" id="count_vowels"> +<a class="viewcode-back" href="../string_operators.html#string_operators.count_vowels">[docs]</a> +<span class="k">def</span><span class="w"> </span><span class="nf">count_vowels</span><span class="p">(</span><span class="n">string</span><span class="p">):</span> +<span class="w"> </span><span class="sd">"""</span> +<span class="sd"> Counts the number of vowels in a string.</span> + +<span class="sd"> Parameters:</span> +<span class="sd"> string (str): The string to check.</span> + +<span class="sd"> Returns:</span> +<span class="sd"> int: The number of vowels in the string.</span> +<span class="sd"> """</span> + <span class="n">vowels</span> <span class="o">=</span> <span class="s2">"aeiouAEIOU"</span> + <span class="k">return</span> <span class="nb">sum</span><span class="p">(</span><span class="mi">1</span> <span class="k">for</span> <span class="n">char</span> <span class="ow">in</span> <span class="n">string</span> <span class="k">if</span> <span class="n">char</span> <span class="ow">in</span> <span class="n">vowels</span><span class="p">)</span></div> + + +<div class="viewcode-block" id="to_uppercase"> +<a class="viewcode-back" href="../string_operators.html#string_operators.to_uppercase">[docs]</a> +<span class="k">def</span><span class="w"> </span><span class="nf">to_uppercase</span><span class="p">(</span><span class="n">string</span><span class="p">):</span> +<span class="w"> </span><span class="sd">"""</span> +<span class="sd"> Converts the string to uppercase.</span> + +<span class="sd"> Parameters:</span> +<span class="sd"> string (str): The string to convert.</span> + +<span class="sd"> Returns:</span> +<span class="sd"> str: The string in uppercase.</span> +<span class="sd"> """</span> + <span class="k">return</span> <span class="n">string</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span></div> + +</pre></div> + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="Main"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="../index.html">The Wizzard Calc</a></h1> + + + + + + + + +<h3>Navigation</h3> +<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../modules.html">wizzard_code</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../index.html">Documentation overview</a><ul> + <li><a href="index.html">Module code</a><ul> + </ul></li> + </ul></li> +</ul> +</div> +<search id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="../search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> + <input type="submit" value="Go" /> + </form> + </div> +</search> +<script>document.getElementById('searchbox').style.display = "block"</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2025, The Author. + + | + Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a> + & <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a> + + </div> + + + + + </body> +</html> \ No newline at end of file diff --git a/case-5-docs/docs/build/html/_sources/index.rst.txt b/case-5-docs/docs/build/html/_sources/index.rst.txt index b028898fcb2f059b8f30feea235d73b0267b3ab3..b4c95dc114f5bd18882bf8247d41d3df115ce349 100644 --- a/case-5-docs/docs/build/html/_sources/index.rst.txt +++ b/case-5-docs/docs/build/html/_sources/index.rst.txt @@ -1,18 +1,19 @@ -.. my_project documentation master file, created by - sphinx-quickstart on Wed Mar 1 2025. +.. The Wizzard Calc documentation master file, created by + sphinx-quickstart on Thu Mar 27 10:31:45 2025. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. -Welcome to my_project's documentation! -====================================== +The Wizzard Calc documentation +============================== -This is a simple project with basic math and string operations. The documentation will be automatically generated using Sphinx. +Add your content using ``reStructuredText`` syntax. See the +`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_ +documentation for details. -Contents: -- Math Operations -- String Operations .. toctree:: :maxdepth: 2 :caption: Contents: - math_operations - string_operations + modules + diff --git a/case-5-docs/docs/build/html/_sources/math_operations.rst.txt b/case-5-docs/docs/build/html/_sources/math_operations.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..b3139aa1e197061a7cfb99989cab24e73f3c08e3 --- /dev/null +++ b/case-5-docs/docs/build/html/_sources/math_operations.rst.txt @@ -0,0 +1,7 @@ +math\_operations module +======================= + +.. automodule:: math_operations + :members: + :show-inheritance: + :undoc-members: diff --git a/case-5-docs/docs/build/html/_sources/modules.rst.txt b/case-5-docs/docs/build/html/_sources/modules.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..1751ce57d1e01228632801e8045777eb72af5f2a --- /dev/null +++ b/case-5-docs/docs/build/html/_sources/modules.rst.txt @@ -0,0 +1,8 @@ +wizzard_code +============ + +.. toctree:: + :maxdepth: 4 + + math_operations + string_operators diff --git a/case-5-docs/docs/build/html/_sources/string_operators.rst.txt b/case-5-docs/docs/build/html/_sources/string_operators.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..8ce0f051b2d8eb554c8d6e6c2cd7cdc08c11c63f --- /dev/null +++ b/case-5-docs/docs/build/html/_sources/string_operators.rst.txt @@ -0,0 +1,7 @@ +string\_operators module +======================== + +.. automodule:: string_operators + :members: + :show-inheritance: + :undoc-members: diff --git a/case-5-docs/docs/build/html/_static/alabaster.css b/case-5-docs/docs/build/html/_static/alabaster.css new file mode 100644 index 0000000000000000000000000000000000000000..e3174bf93330c46c312dd303435df091aed0b230 --- /dev/null +++ b/case-5-docs/docs/build/html/_static/alabaster.css @@ -0,0 +1,708 @@ +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: Georgia, serif; + font-size: 17px; + background-color: #fff; + color: #000; + margin: 0; + padding: 0; +} + + +div.document { + width: 940px; + margin: 30px auto 0 auto; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 220px; +} + +div.sphinxsidebar { + width: 220px; + font-size: 14px; + line-height: 1.5; +} + +hr { + border: 1px solid #B1B4B6; +} + +div.body { + background-color: #fff; + color: #3E4349; + padding: 0 30px 0 30px; +} + +div.body > .section { + text-align: left; +} + +div.footer { + width: 940px; + margin: 20px auto 30px auto; + font-size: 14px; + color: #888; + text-align: right; +} + +div.footer a { + color: #888; +} + +p.caption { + font-family: inherit; + font-size: inherit; +} + + +div.relations { + display: none; +} + + +div.sphinxsidebar { + max-height: 100%; + overflow-y: auto; +} + +div.sphinxsidebar a { + color: #444; + text-decoration: none; + border-bottom: 1px dotted #999; +} + +div.sphinxsidebar a:hover { + border-bottom: 1px solid #999; +} + +div.sphinxsidebarwrapper { + padding: 18px 10px; +} + +div.sphinxsidebarwrapper p.logo { + padding: 0; + margin: -10px 0 0 0px; + text-align: center; +} + +div.sphinxsidebarwrapper h1.logo { + margin-top: -10px; + text-align: center; + margin-bottom: 5px; + text-align: left; +} + +div.sphinxsidebarwrapper h1.logo-name { + margin-top: 0px; +} + +div.sphinxsidebarwrapper p.blurb { + margin-top: 0; + font-style: normal; +} + +div.sphinxsidebar h3, +div.sphinxsidebar h4 { + font-family: Georgia, serif; + color: #444; + font-size: 24px; + font-weight: normal; + margin: 0 0 5px 0; + padding: 0; +} + +div.sphinxsidebar h4 { + font-size: 20px; +} + +div.sphinxsidebar h3 a { + color: #444; +} + +div.sphinxsidebar p.logo a, +div.sphinxsidebar h3 a, +div.sphinxsidebar p.logo a:hover, +div.sphinxsidebar h3 a:hover { + border: none; +} + +div.sphinxsidebar p { + color: #555; + margin: 10px 0; +} + +div.sphinxsidebar ul { + margin: 10px 0; + padding: 0; + color: #000; +} + +div.sphinxsidebar ul li.toctree-l1 > a { + font-size: 120%; +} + +div.sphinxsidebar ul li.toctree-l2 > a { + font-size: 110%; +} + +div.sphinxsidebar input { + border: 1px solid #CCC; + font-family: Georgia, serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox input[type="text"] { + width: 160px; +} + +div.sphinxsidebar .search > div { + display: table-cell; +} + +div.sphinxsidebar hr { + border: none; + height: 1px; + color: #AAA; + background: #AAA; + + text-align: left; + margin-left: 0; + width: 50%; +} + +div.sphinxsidebar .badge { + border-bottom: none; +} + +div.sphinxsidebar .badge:hover { + border-bottom: none; +} + +/* To address an issue with donation coming after search */ +div.sphinxsidebar h3.donation { + margin-top: 10px; +} + +/* -- body styles ----------------------------------------------------------- */ + +a { + color: #004B6B; + text-decoration: underline; +} + +a:hover { + color: #6D4100; + text-decoration: underline; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: Georgia, serif; + font-weight: normal; + margin: 30px 0px 10px 0px; + padding: 0; +} + +div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } +div.body h2 { font-size: 180%; } +div.body h3 { font-size: 150%; } +div.body h4 { font-size: 130%; } +div.body h5 { font-size: 100%; } +div.body h6 { font-size: 100%; } + +a.headerlink { + color: #DDD; + padding: 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + color: #444; + background: #EAEAEA; +} + +div.body p, div.body dd, div.body li { + line-height: 1.4em; +} + +div.admonition { + margin: 20px 0px; + padding: 10px 30px; + background-color: #EEE; + border: 1px solid #CCC; +} + +div.admonition tt.xref, div.admonition code.xref, div.admonition a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fafafa; +} + +div.admonition p.admonition-title { + font-family: Georgia, serif; + font-weight: normal; + font-size: 24px; + margin: 0 0 10px 0; + padding: 0; + line-height: 1; +} + +div.admonition p.last { + margin-bottom: 0; +} + +div.highlight { + background-color: #fff; +} + +dt:target, .highlight { + background: #FAF3E8; +} + +div.warning { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.danger { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.error { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.caution { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.attention { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.important { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.note { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.tip { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.hint { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.seealso { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.topic { + background-color: #EEE; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre, tt, code { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; + font-size: 0.9em; +} + +.hll { + background-color: #FFC; + margin: 0 -12px; + padding: 0 12px; + display: block; +} + +img.screenshot { +} + +tt.descname, tt.descclassname, code.descname, code.descclassname { + font-size: 0.95em; +} + +tt.descname, code.descname { + padding-right: 0.08em; +} + +img.screenshot { + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils { + border: 1px solid #888; + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils td, table.docutils th { + border: 1px solid #888; + padding: 0.25em 0.7em; +} + +table.field-list, table.footnote { + border: none; + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + +table.footnote { + margin: 15px 0; + width: 100%; + border: 1px solid #EEE; + background: #FDFDFD; + font-size: 0.9em; +} + +table.footnote + table.footnote { + margin-top: -15px; + border-top: none; +} + +table.field-list th { + padding: 0 0.8em 0 0; +} + +table.field-list td { + padding: 0; +} + +table.field-list p { + margin-bottom: 0.8em; +} + +/* Cloned from + * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68 + */ +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +table.footnote td.label { + width: .1px; + padding: 0.3em 0 0.3em 0.5em; +} + +table.footnote td { + padding: 0.3em 0.5em; +} + +dl { + margin-left: 0; + margin-right: 0; + margin-top: 0; + padding: 0; +} + +dl dd { + margin-left: 30px; +} + +blockquote { + margin: 0 0 0 30px; + padding: 0; +} + +ul, ol { + /* Matches the 30px from the narrow-screen "li > ul" selector below */ + margin: 10px 0 10px 30px; + padding: 0; +} + +pre { + background: #EEE; + padding: 7px 30px; + margin: 15px 0px; + line-height: 1.3em; +} + +div.viewcode-block:target { + background: #ffd; +} + +dl pre, blockquote pre, li pre { + margin-left: 0; + padding-left: 30px; +} + +tt, code { + background-color: #ecf0f3; + color: #222; + /* padding: 1px 2px; */ +} + +tt.xref, code.xref, a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fff; +} + +a.reference { + text-decoration: none; + border-bottom: 1px dotted #004B6B; +} + +/* Don't put an underline on images */ +a.image-reference, a.image-reference:hover { + border-bottom: none; +} + +a.reference:hover { + border-bottom: 1px solid #6D4100; +} + +a.footnote-reference { + text-decoration: none; + font-size: 0.7em; + vertical-align: top; + border-bottom: 1px dotted #004B6B; +} + +a.footnote-reference:hover { + border-bottom: 1px solid #6D4100; +} + +a:hover tt, a:hover code { + background: #EEE; +} + + +@media screen and (max-width: 870px) { + + div.sphinxsidebar { + display: none; + } + + div.document { + width: 100%; + + } + + div.documentwrapper { + margin-left: 0; + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + } + + div.bodywrapper { + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + margin-left: 0; + } + + ul { + margin-left: 0; + } + + li > ul { + /* Matches the 30px from the "ul, ol" selector above */ + margin-left: 30px; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .bodywrapper { + margin: 0; + } + + .footer { + width: auto; + } + + .github { + display: none; + } + + + +} + + + +@media screen and (max-width: 875px) { + + body { + margin: 0; + padding: 20px 30px; + } + + div.documentwrapper { + float: none; + background: #fff; + } + + div.sphinxsidebar { + display: block; + float: none; + width: 102.5%; + margin: 50px -30px -20px -30px; + padding: 10px 20px; + background: #333; + color: #FFF; + } + + div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, + div.sphinxsidebar h3 a { + color: #fff; + } + + div.sphinxsidebar a { + color: #AAA; + } + + div.sphinxsidebar p.logo { + display: none; + } + + div.document { + width: 100%; + margin: 0; + } + + div.footer { + display: none; + } + + div.bodywrapper { + margin: 0; + } + + div.body { + min-height: 0; + padding: 0; + } + + .rtd_doc_footer { + display: none; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .footer { + width: auto; + } + + .github { + display: none; + } +} + + +/* misc. */ + +.revsys-inline { + display: none!important; +} + +/* Hide ugly table cell borders in ..bibliography:: directive output */ +table.docutils.citation, table.docutils.citation td, table.docutils.citation th { + border: none; + /* Below needed in some edge cases; if not applied, bottom shadows appear */ + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + + +/* relbar */ + +.related { + line-height: 30px; + width: 100%; + font-size: 0.9rem; +} + +.related.top { + border-bottom: 1px solid #EEE; + margin-bottom: 20px; +} + +.related.bottom { + border-top: 1px solid #EEE; +} + +.related ul { + padding: 0; + margin: 0; + list-style: none; +} + +.related li { + display: inline; +} + +nav#rellinks { + float: right; +} + +nav#rellinks li+li:before { + content: "|"; +} + +nav#breadcrumbs li+li:before { + content: "\00BB"; +} + +/* Hide certain items when printing */ +@media print { + div.related { + display: none; + } +} \ No newline at end of file diff --git a/case-5-docs/docs/build/html/_static/custom.css b/case-5-docs/docs/build/html/_static/custom.css new file mode 100644 index 0000000000000000000000000000000000000000..2a924f1d6a8bc930c5296bdb2d5c2d3e39b04a1c --- /dev/null +++ b/case-5-docs/docs/build/html/_static/custom.css @@ -0,0 +1 @@ +/* This file intentionally left blank. */ diff --git a/case-5-docs/docs/build/html/_static/documentation_options.js b/case-5-docs/docs/build/html/_static/documentation_options.js index 13d90ff0b0af1b0c52379e6bb32b282468766542..6e7e2d04c92ced8a433027a4f9cbbcf4946d0c1b 100644 --- a/case-5-docs/docs/build/html/_static/documentation_options.js +++ b/case-5-docs/docs/build/html/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '0.1.0', + VERSION: 'o.1', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/case-5-docs/docs/build/html/genindex.html b/case-5-docs/docs/build/html/genindex.html index 0f0d3988bd6f488bffb6984553fcbb4118f79b97..00dba22e91274415faa7233315bb2508327e45ff 100644 --- a/case-5-docs/docs/build/html/genindex.html +++ b/case-5-docs/docs/build/html/genindex.html @@ -5,14 +5,14 @@ <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Index — case10-docs 0.1.0 documentation</title> + <title>Index — The Wizzard Calc o.1 documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> <script src="_static/jquery.js?v=5d32c60e"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> - <script src="_static/documentation_options.js?v=01f34227"></script> + <script src="_static/documentation_options.js?v=f8b91ae0"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/js/theme.js"></script> @@ -29,7 +29,7 @@ <a href="index.html" class="icon icon-home"> - case10-docs + The Wizzard Calc </a> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> @@ -39,15 +39,18 @@ </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> - <!-- Local TOC --> - <div class="local-toc"></div> + <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="modules.html">wizzard_code</a></li> +</ul> + </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="index.html">case10-docs</a> + <a href="index.html">The Wizzard Calc</a> </nav> <div class="wy-nav-content"> @@ -68,8 +71,102 @@ <h1 id="index">Index</h1> <div class="genindex-jumpbox"> + <a href="#A"><strong>A</strong></a> + | <a href="#C"><strong>C</strong></a> + | <a href="#D"><strong>D</strong></a> + | <a href="#M"><strong>M</strong></a> + | <a href="#R"><strong>R</strong></a> + | <a href="#S"><strong>S</strong></a> + | <a href="#T"><strong>T</strong></a> </div> +<h2 id="A">A</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="math_operations.html#math_operations.add">add() (in module math_operations)</a> +</li> + </ul></td> +</tr></table> + +<h2 id="C">C</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="string_operators.html#string_operators.concatenate">concatenate() (in module string_operators)</a> +</li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="string_operators.html#string_operators.count_vowels">count_vowels() (in module string_operators)</a> +</li> + </ul></td> +</tr></table> + +<h2 id="D">D</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="math_operations.html#math_operations.divide">divide() (in module math_operations)</a> +</li> + </ul></td> +</tr></table> + +<h2 id="M">M</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li> + math_operations + + <ul> + <li><a href="math_operations.html#module-math_operations">module</a> +</li> + </ul></li> + <li> + module + + <ul> + <li><a href="math_operations.html#module-math_operations">math_operations</a> +</li> + <li><a href="string_operators.html#module-string_operators">string_operators</a> +</li> + </ul></li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="math_operations.html#math_operations.multiply">multiply() (in module math_operations)</a> +</li> + </ul></td> +</tr></table> + +<h2 id="R">R</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="string_operators.html#string_operators.reverse_string">reverse_string() (in module string_operators)</a> +</li> + </ul></td> +</tr></table> + +<h2 id="S">S</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li> + string_operators + + <ul> + <li><a href="string_operators.html#module-string_operators">module</a> +</li> + </ul></li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="math_operations.html#math_operations.subtract">subtract() (in module math_operations)</a> +</li> + </ul></td> +</tr></table> + +<h2 id="T">T</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="string_operators.html#string_operators.to_uppercase">to_uppercase() (in module string_operators)</a> +</li> + </ul></td> +</tr></table> + </div> @@ -79,7 +176,7 @@ <hr/> <div role="contentinfo"> - <p>© Copyright 2025, Elizabeth.</p> + <p>© Copyright 2025, The Author.</p> </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a diff --git a/case-5-docs/docs/build/html/index.html b/case-5-docs/docs/build/html/index.html index 728e99adb8aa521112bc0396b9fb093d09fd9be5..f9c8268ebd076c4a536beba76c885a41c84d2b79 100644 --- a/case-5-docs/docs/build/html/index.html +++ b/case-5-docs/docs/build/html/index.html @@ -6,19 +6,20 @@ <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Welcome to my_project’s documentation! — case10-docs 0.1.0 documentation</title> + <title>The Wizzard Calc documentation — The Wizzard Calc o.1 documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> <script src="_static/jquery.js?v=5d32c60e"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> - <script src="_static/documentation_options.js?v=01f34227"></script> + <script src="_static/documentation_options.js?v=f8b91ae0"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex.html" /> - <link rel="search" title="Search" href="search.html" /> + <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="wizzard_code" href="modules.html" /> </head> <body class="wy-body-for-nav"> @@ -30,7 +31,7 @@ <a href="#" class="icon icon-home"> - case10-docs + The Wizzard Calc </a> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> @@ -40,18 +41,18 @@ </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> - <!-- Local TOC --> - <div class="local-toc"><ul> -<li><a class="reference internal" href="#">Welcome to my_project’s documentation!</a></li> + <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="modules.html">wizzard_code</a></li> </ul> -</div> + </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="#">case10-docs</a> + <a href="#">The Wizzard Calc</a> </nav> <div class="wy-nav-content"> @@ -59,7 +60,7 @@ <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="#" class="icon icon-home" aria-label="Home"></a></li> - <li class="breadcrumb-item active">Welcome to my_project’s documentation!</li> + <li class="breadcrumb-item active">The Wizzard Calc documentation</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a> </li> @@ -69,25 +70,34 @@ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> - <section id="welcome-to-my-project-s-documentation"> -<h1>Welcome to my_project’s documentation!<a class="headerlink" href="#welcome-to-my-project-s-documentation" title="Link to this heading"></a></h1> -<p>This is a simple project with basic math and string operations. The documentation will be automatically generated using Sphinx.</p> -<p>Contents: -- Math Operations -- String Operations</p> + <section id="the-wizzard-calc-documentation"> +<h1>The Wizzard Calc documentation<a class="headerlink" href="#the-wizzard-calc-documentation" title="Link to this heading"></a></h1> +<p>Add your content using <code class="docutils literal notranslate"><span class="pre">reStructuredText</span></code> syntax. See the +<a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html">reStructuredText</a> +documentation for details.</p> <div class="toctree-wrapper compound"> +<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="modules.html">wizzard_code</a><ul> +<li class="toctree-l2"><a class="reference internal" href="math_operations.html">math_operations module</a></li> +<li class="toctree-l2"><a class="reference internal" href="string_operators.html">string_operators module</a></li> +</ul> +</li> +</ul> </div> </section> </div> </div> - <footer> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="modules.html" class="btn btn-neutral float-right" title="wizzard_code" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> <hr/> <div role="contentinfo"> - <p>© Copyright 2025, Elizabeth.</p> + <p>© Copyright 2025, The Author.</p> </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a diff --git a/case-5-docs/docs/build/html/math_operations.html b/case-5-docs/docs/build/html/math_operations.html new file mode 100644 index 0000000000000000000000000000000000000000..72050cfce81cf4a791f9e24d5c99cff84ad62821 --- /dev/null +++ b/case-5-docs/docs/build/html/math_operations.html @@ -0,0 +1,167 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" data-content_root="./"> +<head> + <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>math_operations module — The Wizzard Calc o.1 documentation</title> + <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> + <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> + + + <script src="_static/jquery.js?v=5d32c60e"></script> + <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> + <script src="_static/documentation_options.js?v=f8b91ae0"></script> + <script src="_static/doctools.js?v=9bcbadda"></script> + <script src="_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="_static/js/theme.js"></script> + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="string_operators module" href="string_operators.html" /> + <link rel="prev" title="wizzard_code" href="modules.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="index.html" class="icon icon-home"> + The Wizzard Calc + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="modules.html">wizzard_code</a><ul class="current"> +<li class="toctree-l2 current"><a class="current reference internal" href="#">math_operations module</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#math_operations.add"><code class="docutils literal notranslate"><span class="pre">add()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="#math_operations.divide"><code class="docutils literal notranslate"><span class="pre">divide()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="#math_operations.multiply"><code class="docutils literal notranslate"><span class="pre">multiply()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="#math_operations.subtract"><code class="docutils literal notranslate"><span class="pre">subtract()</span></code></a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="string_operators.html">string_operators module</a></li> +</ul> +</li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">The Wizzard Calc</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item"><a href="modules.html">wizzard_code</a></li> + <li class="breadcrumb-item active">math_operations module</li> + <li class="wy-breadcrumbs-aside"> + <a href="_sources/math_operations.rst.txt" rel="nofollow"> View page source</a> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="module-math_operations"> +<span id="math-operations-module"></span><h1>math_operations module<a class="headerlink" href="#module-math_operations" title="Link to this heading"></a></h1> +<p>This module contains basic mathematical operations.</p> +<dl class="py function"> +<dt class="sig sig-object py" id="math_operations.add"> +<span class="sig-prename descclassname"><span class="pre">math_operations.</span></span><span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">a</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">b</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/math_operations.html#add"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#math_operations.add" title="Link to this definition"></a></dt> +<dd><p>Adds two numbers.</p> +<p>Parameters: +a (int, float): The first number. +b (int, float): The second number.</p> +<p>Returns: +int, float: The sum of the two numbers.</p> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="math_operations.divide"> +<span class="sig-prename descclassname"><span class="pre">math_operations.</span></span><span class="sig-name descname"><span class="pre">divide</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">a</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">b</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/math_operations.html#divide"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#math_operations.divide" title="Link to this definition"></a></dt> +<dd><p>Divides the first number by the second.</p> +<p>Parameters: +a (int, float): The numerator. +b (int, float): The denominator.</p> +<p>Returns: +float: The quotient of the division.</p> +<p>Raises: +ValueError: If the denominator is zero.</p> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="math_operations.multiply"> +<span class="sig-prename descclassname"><span class="pre">math_operations.</span></span><span class="sig-name descname"><span class="pre">multiply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">a</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">b</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/math_operations.html#multiply"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#math_operations.multiply" title="Link to this definition"></a></dt> +<dd><p>Multiplies two numbers.</p> +<p>Parameters: +a (int, float): The first number. +b (int, float): The second number.</p> +<p>Returns: +int, float: The product of the two numbers.</p> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="math_operations.subtract"> +<span class="sig-prename descclassname"><span class="pre">math_operations.</span></span><span class="sig-name descname"><span class="pre">subtract</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">a</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">b</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/math_operations.html#subtract"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#math_operations.subtract" title="Link to this definition"></a></dt> +<dd><p>Subtracts the second number from the first.</p> +<p>Parameters: +a (int, float): The first number. +b (int, float): The second number.</p> +<p>Returns: +int, float: The difference between the two numbers.</p> +</dd></dl> + +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="modules.html" class="btn btn-neutral float-left" title="wizzard_code" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="string_operators.html" class="btn btn-neutral float-right" title="string_operators module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 2025, The Author.</p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html> \ No newline at end of file diff --git a/case-5-docs/docs/build/html/modules.html b/case-5-docs/docs/build/html/modules.html new file mode 100644 index 0000000000000000000000000000000000000000..a5e10d29b3c8c9183e609a3088b0d50673ab4e7a --- /dev/null +++ b/case-5-docs/docs/build/html/modules.html @@ -0,0 +1,131 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" data-content_root="./"> +<head> + <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>wizzard_code — The Wizzard Calc o.1 documentation</title> + <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> + <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> + + + <script src="_static/jquery.js?v=5d32c60e"></script> + <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> + <script src="_static/documentation_options.js?v=f8b91ae0"></script> + <script src="_static/doctools.js?v=9bcbadda"></script> + <script src="_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="_static/js/theme.js"></script> + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="math_operations module" href="math_operations.html" /> + <link rel="prev" title="The Wizzard Calc documentation" href="index.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="index.html" class="icon icon-home"> + The Wizzard Calc + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul class="current"> +<li class="toctree-l1 current"><a class="current reference internal" href="#">wizzard_code</a><ul> +<li class="toctree-l2"><a class="reference internal" href="math_operations.html">math_operations module</a></li> +<li class="toctree-l2"><a class="reference internal" href="string_operators.html">string_operators module</a></li> +</ul> +</li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">The Wizzard Calc</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item active">wizzard_code</li> + <li class="wy-breadcrumbs-aside"> + <a href="_sources/modules.rst.txt" rel="nofollow"> View page source</a> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="wizzard-code"> +<h1>wizzard_code<a class="headerlink" href="#wizzard-code" title="Link to this heading"></a></h1> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="math_operations.html">math_operations module</a><ul> +<li class="toctree-l2"><a class="reference internal" href="math_operations.html#math_operations.add"><code class="docutils literal notranslate"><span class="pre">add()</span></code></a></li> +<li class="toctree-l2"><a class="reference internal" href="math_operations.html#math_operations.divide"><code class="docutils literal notranslate"><span class="pre">divide()</span></code></a></li> +<li class="toctree-l2"><a class="reference internal" href="math_operations.html#math_operations.multiply"><code class="docutils literal notranslate"><span class="pre">multiply()</span></code></a></li> +<li class="toctree-l2"><a class="reference internal" href="math_operations.html#math_operations.subtract"><code class="docutils literal notranslate"><span class="pre">subtract()</span></code></a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="string_operators.html">string_operators module</a><ul> +<li class="toctree-l2"><a class="reference internal" href="string_operators.html#string_operators.concatenate"><code class="docutils literal notranslate"><span class="pre">concatenate()</span></code></a></li> +<li class="toctree-l2"><a class="reference internal" href="string_operators.html#string_operators.count_vowels"><code class="docutils literal notranslate"><span class="pre">count_vowels()</span></code></a></li> +<li class="toctree-l2"><a class="reference internal" href="string_operators.html#string_operators.reverse_string"><code class="docutils literal notranslate"><span class="pre">reverse_string()</span></code></a></li> +<li class="toctree-l2"><a class="reference internal" href="string_operators.html#string_operators.to_uppercase"><code class="docutils literal notranslate"><span class="pre">to_uppercase()</span></code></a></li> +</ul> +</li> +</ul> +</div> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="index.html" class="btn btn-neutral float-left" title="The Wizzard Calc documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="math_operations.html" class="btn btn-neutral float-right" title="math_operations module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 2025, The Author.</p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html> \ No newline at end of file diff --git a/case-5-docs/docs/build/html/objects.inv b/case-5-docs/docs/build/html/objects.inv index f3adc9d617ecf3544aaf1c8d3ccf924ad6bb56b5..f2b343eb6b43c047c76e4dba302e233738f5d845 100644 Binary files a/case-5-docs/docs/build/html/objects.inv and b/case-5-docs/docs/build/html/objects.inv differ diff --git a/case-5-docs/docs/build/html/py-modindex.html b/case-5-docs/docs/build/html/py-modindex.html new file mode 100644 index 0000000000000000000000000000000000000000..68d86e6332d7472002bd2c0f2ce7b16c9c1c6021 --- /dev/null +++ b/case-5-docs/docs/build/html/py-modindex.html @@ -0,0 +1,132 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" data-content_root="./"> +<head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>Python Module Index — The Wizzard Calc o.1 documentation</title> + <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> + <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> + + + <script src="_static/jquery.js?v=5d32c60e"></script> + <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> + <script src="_static/documentation_options.js?v=f8b91ae0"></script> + <script src="_static/doctools.js?v=9bcbadda"></script> + <script src="_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="_static/js/theme.js"></script> + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="search.html" /> + + + <script> + DOCUMENTATION_OPTIONS.COLLAPSE_INDEX = true; + </script> + + +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="index.html" class="icon icon-home"> + The Wizzard Calc + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="modules.html">wizzard_code</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">The Wizzard Calc</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item active">Python Module Index</li> + <li class="wy-breadcrumbs-aside"> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + + <h1>Python Module Index</h1> + + <div class="modindex-jumpbox"> + <a href="#cap-m"><strong>m</strong></a> | + <a href="#cap-s"><strong>s</strong></a> + </div> + + <table class="indextable modindextable"> + <tr class="pcap"><td></td><td> </td><td></td></tr> + <tr class="cap" id="cap-m"><td></td><td> + <strong>m</strong></td><td></td></tr> + <tr> + <td></td> + <td> + <a href="math_operations.html#module-math_operations"><code class="xref">math_operations</code></a></td><td> + <em></em></td></tr> + <tr class="pcap"><td></td><td> </td><td></td></tr> + <tr class="cap" id="cap-s"><td></td><td> + <strong>s</strong></td><td></td></tr> + <tr> + <td></td> + <td> + <a href="string_operators.html#module-string_operators"><code class="xref">string_operators</code></a></td><td> + <em></em></td></tr> + </table> + + + </div> + </div> + <footer> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 2025, The Author.</p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html> \ No newline at end of file diff --git a/case-5-docs/docs/build/html/search.html b/case-5-docs/docs/build/html/search.html index 87d33c793ab54527eba1267666b66a2b5156cef1..bc20107785643929ec429bdc1c8b5f98af682d05 100644 --- a/case-5-docs/docs/build/html/search.html +++ b/case-5-docs/docs/build/html/search.html @@ -5,7 +5,7 @@ <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Search — case10-docs 0.1.0 documentation</title> + <title>Search — The Wizzard Calc o.1 documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> @@ -13,7 +13,7 @@ <script src="_static/jquery.js?v=5d32c60e"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> - <script src="_static/documentation_options.js?v=01f34227"></script> + <script src="_static/documentation_options.js?v=f8b91ae0"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/js/theme.js"></script> @@ -32,7 +32,7 @@ <a href="index.html" class="icon icon-home"> - case10-docs + The Wizzard Calc </a> <div role="search"> <form id="rtd-search-form" class="wy-form" action="#" method="get"> @@ -42,15 +42,18 @@ </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> - <!-- Local TOC --> - <div class="local-toc"></div> + <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="modules.html">wizzard_code</a></li> +</ul> + </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="index.html">case10-docs</a> + <a href="index.html">The Wizzard Calc</a> </nav> <div class="wy-nav-content"> @@ -87,7 +90,7 @@ <hr/> <div role="contentinfo"> - <p>© Copyright 2025, Elizabeth.</p> + <p>© Copyright 2025, The Author.</p> </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a diff --git a/case-5-docs/docs/build/html/searchindex.js b/case-5-docs/docs/build/html/searchindex.js index 584e9f168da7f470e83ac39eda08499c809d6e7c..1ca38aaca7408846886864bdd1cff13ffc6855d4 100644 --- a/case-5-docs/docs/build/html/searchindex.js +++ b/case-5-docs/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles":{"Welcome to my_project\u2019s documentation!":[[0,null]]},"docnames":["index"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2},"filenames":["index.rst"],"indexentries":{},"objects":{},"objnames":{},"objtypes":{},"terms":{"The":0,"automat":0,"basic":0,"content":0,"gener":0,"i":0,"math":0,"oper":0,"project":0,"simpl":0,"sphinx":0,"string":0,"thi":0,"us":0},"titles":["Welcome to my_project\u2019s documentation!"],"titleterms":{"":0,"document":0,"my_project":0,"welcom":0}}) \ No newline at end of file +Search.setIndex({"alltitles":{"Contents:":[[0,null]],"The Wizzard Calc documentation":[[0,null]],"math_operations module":[[1,null]],"string_operators module":[[3,null]],"wizzard_code":[[2,null]]},"docnames":["index","math_operations","modules","string_operators"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.viewcode":1},"filenames":["index.rst","math_operations.rst","modules.rst","string_operators.rst"],"indexentries":{"add() (in module math_operations)":[[1,"math_operations.add",false]],"concatenate() (in module string_operators)":[[3,"string_operators.concatenate",false]],"count_vowels() (in module string_operators)":[[3,"string_operators.count_vowels",false]],"divide() (in module math_operations)":[[1,"math_operations.divide",false]],"math_operations":[[1,"module-math_operations",false]],"module":[[1,"module-math_operations",false],[3,"module-string_operators",false]],"multiply() (in module math_operations)":[[1,"math_operations.multiply",false]],"reverse_string() (in module string_operators)":[[3,"string_operators.reverse_string",false]],"string_operators":[[3,"module-string_operators",false]],"subtract() (in module math_operations)":[[1,"math_operations.subtract",false]],"to_uppercase() (in module string_operators)":[[3,"string_operators.to_uppercase",false]]},"objects":{"":[[1,0,0,"-","math_operations"],[3,0,0,"-","string_operators"]],"math_operations":[[1,1,1,"","add"],[1,1,1,"","divide"],[1,1,1,"","multiply"],[1,1,1,"","subtract"]],"string_operators":[[3,1,1,"","concatenate"],[3,1,1,"","count_vowels"],[3,1,1,"","reverse_string"],[3,1,1,"","to_uppercase"]]},"objnames":{"0":["py","module","Python module"],"1":["py","function","Python function"]},"objtypes":{"0":"py:module","1":"py:function"},"terms":{"If":1,"The":[1,3],"add":[0,1,2],"b":1,"basic":[1,3],"between":1,"check":3,"concaten":[2,3],"contain":[1,3],"convert":3,"count":3,"count_vowel":[2,3],"denomin":1,"detail":0,"differ":1,"divid":[1,2],"divis":1,"first":[1,3],"float":1,"from":1,"given":3,"i":1,"int":[1,3],"math_oper":[0,2],"mathemat":1,"modul":[0,2],"multipli":[1,2],"number":[1,3],"numer":1,"oper":[1,3],"paramet":[1,3],"product":1,"quotient":1,"rais":1,"restructuredtext":0,"return":[1,3],"revers":3,"reverse_str":[2,3],"second":[1,3],"see":0,"sourc":[1,3],"str":3,"str1":3,"str2":3,"string":3,"string_oper":[0,2],"subtract":[1,2],"sum":1,"syntax":0,"thi":[1,3],"to_uppercas":[2,3],"two":[1,3],"uppercas":3,"us":0,"valueerror":1,"vowel":3,"wizzard_cod":0,"your":0,"zero":1},"titles":["The Wizzard Calc documentation","math_operations module","wizzard_code","string_operators module"],"titleterms":{"The":0,"calc":0,"content":0,"document":0,"math_oper":1,"modul":[1,3],"string_oper":3,"wizzard":0,"wizzard_cod":2}}) \ No newline at end of file diff --git a/case-5-docs/docs/build/html/string_operators.html b/case-5-docs/docs/build/html/string_operators.html new file mode 100644 index 0000000000000000000000000000000000000000..d17740e45480e658a1897f26364f8c27de407ac8 --- /dev/null +++ b/case-5-docs/docs/build/html/string_operators.html @@ -0,0 +1,160 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" data-content_root="./"> +<head> + <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>string_operators module — The Wizzard Calc o.1 documentation</title> + <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> + <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> + + + <script src="_static/jquery.js?v=5d32c60e"></script> + <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> + <script src="_static/documentation_options.js?v=f8b91ae0"></script> + <script src="_static/doctools.js?v=9bcbadda"></script> + <script src="_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="_static/js/theme.js"></script> + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="search.html" /> + <link rel="prev" title="math_operations module" href="math_operations.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="index.html" class="icon icon-home"> + The Wizzard Calc + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="modules.html">wizzard_code</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="math_operations.html">math_operations module</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">string_operators module</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#string_operators.concatenate"><code class="docutils literal notranslate"><span class="pre">concatenate()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="#string_operators.count_vowels"><code class="docutils literal notranslate"><span class="pre">count_vowels()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="#string_operators.reverse_string"><code class="docutils literal notranslate"><span class="pre">reverse_string()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="#string_operators.to_uppercase"><code class="docutils literal notranslate"><span class="pre">to_uppercase()</span></code></a></li> +</ul> +</li> +</ul> +</li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">The Wizzard Calc</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item"><a href="modules.html">wizzard_code</a></li> + <li class="breadcrumb-item active">string_operators module</li> + <li class="wy-breadcrumbs-aside"> + <a href="_sources/string_operators.rst.txt" rel="nofollow"> View page source</a> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="module-string_operators"> +<span id="string-operators-module"></span><h1>string_operators module<a class="headerlink" href="#module-string_operators" title="Link to this heading"></a></h1> +<p>This module contains basic string operations.</p> +<dl class="py function"> +<dt class="sig sig-object py" id="string_operators.concatenate"> +<span class="sig-prename descclassname"><span class="pre">string_operators.</span></span><span class="sig-name descname"><span class="pre">concatenate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">str1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">str2</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/string_operators.html#concatenate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#string_operators.concatenate" title="Link to this definition"></a></dt> +<dd><p>Concatenates two strings.</p> +<p>Parameters: +str1 (str): The first string. +str2 (str): The second string.</p> +<p>Returns: +str: The concatenation of the two strings.</p> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="string_operators.count_vowels"> +<span class="sig-prename descclassname"><span class="pre">string_operators.</span></span><span class="sig-name descname"><span class="pre">count_vowels</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/string_operators.html#count_vowels"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#string_operators.count_vowels" title="Link to this definition"></a></dt> +<dd><p>Counts the number of vowels in a string.</p> +<p>Parameters: +string (str): The string to check.</p> +<p>Returns: +int: The number of vowels in the string.</p> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="string_operators.reverse_string"> +<span class="sig-prename descclassname"><span class="pre">string_operators.</span></span><span class="sig-name descname"><span class="pre">reverse_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/string_operators.html#reverse_string"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#string_operators.reverse_string" title="Link to this definition"></a></dt> +<dd><p>Reverses a given string.</p> +<p>Parameters: +string (str): The string to reverse.</p> +<p>Returns: +str: The reversed string.</p> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="string_operators.to_uppercase"> +<span class="sig-prename descclassname"><span class="pre">string_operators.</span></span><span class="sig-name descname"><span class="pre">to_uppercase</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/string_operators.html#to_uppercase"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#string_operators.to_uppercase" title="Link to this definition"></a></dt> +<dd><p>Converts the string to uppercase.</p> +<p>Parameters: +string (str): The string to convert.</p> +<p>Returns: +str: The string in uppercase.</p> +</dd></dl> + +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="math_operations.html" class="btn btn-neutral float-left" title="math_operations module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 2025, The Author.</p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html> \ No newline at end of file diff --git a/case-5-docs/docs/main.py b/case-5-docs/docs/main.py deleted file mode 100644 index 6f881ca6268c020bdc56298af91b9d293d913143..0000000000000000000000000000000000000000 --- a/case-5-docs/docs/main.py +++ /dev/null @@ -1,16 +0,0 @@ -def add(a: int, b: int) -> int: - """ - Add two numbers. - - Args: - a (int): The first number. - b (int): The second number. - - Returns: - int: The sum of a and b. - """ - return a + b - -if __name__ == "__main__": - result = add(3, 5) - print(f"Result: {result}") diff --git a/case-5-docs/conf.py b/case-5-docs/docs/source/conf.py similarity index 64% rename from case-5-docs/conf.py rename to case-5-docs/docs/source/conf.py index 8003a0c083d6c151a37b63871997aee3332fd150..534bf1281236c3bc705973c7f38f93c0d4798321 100644 --- a/case-5-docs/conf.py +++ b/case-5-docs/docs/source/conf.py @@ -8,31 +8,33 @@ import os import sys -sys.path.insert(0, os.path.abspath('./case-5-docs/')) -project = 'Case 5: Automated Docs' -copyright = '2025, The Author' -author = 'Bew York Best Selling Author' -version = '0.1' -release = '0.1.0' +sys.path.insert( + 0, os.path.abspath("../../wizzard_code") +) # Adjust the path to your package -# -- General configuration --------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon'] +project = "The Wizzard Calc" +copyright = "2025, The Author" +author = "The Author" +release = "o.1" -templates_path = ['_templates'] -exclude_patterns = ['_build'] +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -master_doc = 'index' -source_suffix = '.rst' +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.napoleon', + 'sphinx.ext.viewcode', +] +templates_path = ["_templates"] +exclude_patterns = [] # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output - import sphinx_rtd_theme -html_theme = 'sphinx_rtd_theme' -html_static_path = ['_static'] +html_theme = "sphinx_rtd_theme" +html_static_path = ["_static"] diff --git a/case-5-docs/docs/source/index.rst b/case-5-docs/docs/source/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..b4c95dc114f5bd18882bf8247d41d3df115ce349 --- /dev/null +++ b/case-5-docs/docs/source/index.rst @@ -0,0 +1,19 @@ +.. The Wizzard Calc documentation master file, created by + sphinx-quickstart on Thu Mar 27 10:31:45 2025. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +The Wizzard Calc documentation +============================== + +Add your content using ``reStructuredText`` syntax. See the +`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_ +documentation for details. + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + modules + diff --git a/case-5-docs/docs/source/math_operations.rst b/case-5-docs/docs/source/math_operations.rst new file mode 100644 index 0000000000000000000000000000000000000000..b3139aa1e197061a7cfb99989cab24e73f3c08e3 --- /dev/null +++ b/case-5-docs/docs/source/math_operations.rst @@ -0,0 +1,7 @@ +math\_operations module +======================= + +.. automodule:: math_operations + :members: + :show-inheritance: + :undoc-members: diff --git a/case-5-docs/docs/source/modules.rst b/case-5-docs/docs/source/modules.rst new file mode 100644 index 0000000000000000000000000000000000000000..1751ce57d1e01228632801e8045777eb72af5f2a --- /dev/null +++ b/case-5-docs/docs/source/modules.rst @@ -0,0 +1,8 @@ +wizzard_code +============ + +.. toctree:: + :maxdepth: 4 + + math_operations + string_operators diff --git a/case-5-docs/docs/source/string_operators.rst b/case-5-docs/docs/source/string_operators.rst new file mode 100644 index 0000000000000000000000000000000000000000..8ce0f051b2d8eb554c8d6e6c2cd7cdc08c11c63f --- /dev/null +++ b/case-5-docs/docs/source/string_operators.rst @@ -0,0 +1,7 @@ +string\_operators module +======================== + +.. automodule:: string_operators + :members: + :show-inheritance: + :undoc-members: diff --git a/case-5-docs/index.rst b/case-5-docs/index.rst deleted file mode 100644 index 9ce5c1a44c60abf3743b0c77f78c1ade2b05f503..0000000000000000000000000000000000000000 --- a/case-5-docs/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. my_project documentation master file, created by - sphinx-quickstart on Wed Mar 1 2025. - -Welcome to Wizzard's documentation! -====================================== - -This is a simple project with basic math and string operations. The documentation will be automatically generated using Sphinx. - -Contents: -- Math Operations -- String Operations - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - docs/math_operations.py - docs/string_operations.py diff --git a/case-5-docs/requirements.txt b/case-5-docs/requirements.txt index 63f9d907583ee953c6ef029c6920634d1d3ecc14..1c950e13c43b43f790ad6a8ad30e81399cee0864 100644 --- a/case-5-docs/requirements.txt +++ b/case-5-docs/requirements.txt @@ -1,3 +1,3 @@ -sphinx==5.0.0 -sphinx-rtd-theme==1.0.0 +sphinx==8.2.3 +sphinx-rtd-theme==3.0.2 sphinx-lint==1.0.0 \ No newline at end of file diff --git a/case-5-docs/solution.txt b/case-5-docs/solution.txt deleted file mode 100644 index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..0000000000000000000000000000000000000000 diff --git a/case-5-docs/docs/math_operations.py b/case-5-docs/wizzard_code/math_operations.py similarity index 100% rename from case-5-docs/docs/math_operations.py rename to case-5-docs/wizzard_code/math_operations.py diff --git a/case-5-docs/docs/string_operators.py b/case-5-docs/wizzard_code/string_operators.py similarity index 100% rename from case-5-docs/docs/string_operators.py rename to case-5-docs/wizzard_code/string_operators.py diff --git a/ci-configs/case-5-docs/generate_docs.yml b/ci-configs/case-5-docs/generate_docs.yml index e50d7f32aab90f0352035341e8a81dbe6a426912..638f8c9974b1412ef0590ef341bd22955eaad073 100644 --- a/ci-configs/case-5-docs/generate_docs.yml +++ b/ci-configs/case-5-docs/generate_docs.yml @@ -1,11 +1,12 @@ generate_docs: stage: build - image: python:3.11 - script: - - pip install --upgrade pip + image: python:3.11-slim + before_script: - pip install -r case-5-docs/requirements.txt - - sphinx-build -b html case-5-docs/docs/source case-5-docs/docs/_build + script: + - sphinx-apidoc -o case-5-docs/docs/source ../ + - sphinx-build -b html case-5-docs/docs/source case-5-docs/docs/_build/html artifacts: paths: - - case-5-docs/build + - case-5-docs/docs/_build/html expire_in: 1 week \ No newline at end of file diff --git a/ci-configs/case-5-docs/pages.yml b/ci-configs/case-5-docs/pages.yml index 7784d4189561764d0e7c44c347be868dde5c182f..72e451f00f32c37e3a87065fa59287ef43b3886b 100644 --- a/ci-configs/case-5-docs/pages.yml +++ b/ci-configs/case-5-docs/pages.yml @@ -2,8 +2,7 @@ pages: stage: deploy image: python:3.11-slim script: - - pip install -r case-5-docs/requirements.txt - - sphinx-build -b html case-5-docs/ public + - mv case-5-docs/docs/_build/html public artifacts: paths: - public