Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions docs/_build/html/dev_guide/architecture/cog_system.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@
<script>DOCUMENTATION_OPTIONS.pagename = 'dev_guide/architecture/cog_system';</script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="&lt;no title&gt;" href="logging_system.html" />
<link rel="prev" title="&lt;no title&gt;" href="database_handler.html" />
<link rel="next" title="Logging System" href="logging_system.html" />
<link rel="prev" title="Database Handler" href="database_handler.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="1.7" />
Expand Down Expand Up @@ -288,10 +288,15 @@
<div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">Developer Guide:</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active has-children"><a class="reference internal" href="index.html">Architecture</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="command_handler.html">Slash Command Handler for ManagerX</a></li>


<li class="toctree-l2"><a class="reference internal" href="event_loop.html">Event Loop</a></li>
<li class="toctree-l2"><a class="reference internal" href="command_handler.html">Command Handler</a></li>
<li class="toctree-l2"><a class="reference internal" href="database_handler.html">Database Handler</a></li>
<li class="toctree-l2 current active"><a class="current reference internal" href="#">Cog System</a></li>
<li class="toctree-l2"><a class="reference internal" href="logging_system.html">Logging System</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../database/index.html">Database</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="simple">
</ul>
</details></li>
</ul>
Expand Down Expand Up @@ -544,15 +549,15 @@ <h2>Best Practices<a class="headerlink" href="#best-practices" title="Link to th
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">&lt;no title&gt;</p>
<p class="prev-next-title">Database Handler</p>
</div>
</a>
<a class="right-next"
href="logging_system.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">&lt;no title&gt;</p>
<p class="prev-next-title">Logging System</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
Expand Down
15 changes: 11 additions & 4 deletions docs/_build/html/dev_guide/architecture/command_handler.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@
<script>DOCUMENTATION_OPTIONS.pagename = 'dev_guide/architecture/command_handler';</script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="&lt;no title&gt;" href="database_handler.html" />
<link rel="prev" title="&lt;no title&gt;" href="event_loop.html" />
<link rel="next" title="Database Handler" href="database_handler.html" />
<link rel="prev" title="Event Loop" href="event_loop.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="1.7" />
Expand Down Expand Up @@ -288,8 +288,15 @@
<div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">Developer Guide:</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active has-children"><a class="reference internal" href="index.html">Architecture</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="event_loop.html">Event Loop</a></li>
<li class="toctree-l2 current active"><a class="current reference internal" href="#">Command Handler</a></li>
<li class="toctree-l2"><a class="reference internal" href="database_handler.html">Database Handler</a></li>
<li class="toctree-l2"><a class="reference internal" href="cog_system.html">Cog System</a></li>
<li class="toctree-l2"><a class="reference internal" href="logging_system.html">Logging System</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../database/index.html">Database</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="simple">
</ul>
</details></li>
</ul>
Expand Down Expand Up @@ -441,15 +448,15 @@ <h2>2. Features Demonstrated<a class="headerlink" href="#features-demonstrated"
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">&lt;no title&gt;</p>
<p class="prev-next-title">Event Loop</p>
</div>
</a>
<a class="right-next"
href="database_handler.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">&lt;no title&gt;</p>
<p class="prev-next-title">Database Handler</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
Expand Down
4 changes: 4 additions & 0 deletions docs/_build/html/dev_guide/architecture/database_handler.html
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,10 @@
<li class="toctree-l2"><a class="reference internal" href="logging_system.html">Logging System</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../database/index.html">Database</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="simple">
</ul>
</details></li>
</ul>
</div>
</nav></div>
Expand Down
4 changes: 4 additions & 0 deletions docs/_build/html/dev_guide/architecture/event_loop.html
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,10 @@
<li class="toctree-l2"><a class="reference internal" href="logging_system.html">Logging System</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../database/index.html">Database</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="simple">
</ul>
</details></li>
</ul>
</div>
</nav></div>
Expand Down
3 changes: 1 addition & 2 deletions docs/_build/html/dev_guide/architecture/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -296,8 +296,7 @@
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../database/index.html">database</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../database/autodelete.html">AutoDelete Database</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../database/index.html">Database</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="simple">
</ul>
</details></li>
</ul>
Expand Down
14 changes: 14 additions & 0 deletions docs/_build/html/dev_guide/architecture/logging_system.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
<script>DOCUMENTATION_OPTIONS.pagename = 'dev_guide/architecture/logging_system';</script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Contributing to ManagerX" href="../contributing/index.html" />
<link rel="prev" title="Cog System" href="cog_system.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
Expand Down Expand Up @@ -294,6 +295,10 @@
<li class="toctree-l2 current active"><a class="current reference internal" href="#">Logging System</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../database/index.html">Database</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="simple">
</ul>
</details></li>
</ul>
</div>
</nav></div>
Expand Down Expand Up @@ -408,6 +413,15 @@ <h2>Conclusion<a class="headerlink" href="#conclusion" title="Link to this headi
<p class="prev-next-title">Cog System</p>
</div>
</a>
<a class="right-next"
href="../contributing/index.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Contributing to ManagerX</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>

Expand Down
9 changes: 4 additions & 5 deletions docs/_build/html/dev_guide/contributing/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
<script>DOCUMENTATION_OPTIONS.pagename = 'dev_guide/contributing/index';</script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Testing ManagerX" href="../testing/index.html" />
<link rel="next" title="Database &amp; Database Handler" href="../database/index.html" />
<link rel="prev" title="Logging System" href="../architecture/logging_system.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
Expand Down Expand Up @@ -296,8 +296,7 @@
</ul>
</details></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Contributing</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../testing/index.html">Testing</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../testing/unit_testing/index.html">Unit Testing</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../database/index.html">Database</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="simple">
</ul>
</details></li>
</ul>
Expand Down Expand Up @@ -432,11 +431,11 @@ <h2>Community Guidelines<a class="headerlink" href="#community-guidelines" title
</div>
</a>
<a class="right-next"
href="../testing/index.html"
href="../database/index.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Testing ManagerX</p>
<p class="prev-next-title">Database &amp; Database Handler</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
Expand Down
20 changes: 1 addition & 19 deletions docs/_build/html/dev_guide/database/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@
<script>DOCUMENTATION_OPTIONS.pagename = 'dev_guide/database/index';</script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="AutoDelete Database" href="autodelete.html" />
<link rel="prev" title="Contributing to ManagerX" href="../contributing/index.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
Expand Down Expand Up @@ -296,8 +295,7 @@
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
<li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">database</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="autodelete.html">AutoDelete Database</a></li>
<li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">Database</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="simple">
</ul>
</details></li>
</ul>
Expand Down Expand Up @@ -364,13 +362,6 @@
<h1>Database &amp; Database Handler<a class="headerlink" href="#database-database-handler" title="Link to this heading">#</a></h1>
<p>ManagerX uses SQLite databases to persist data for various features. Each database handler is responsible for managing a specific feature’s data storage.</p>
<div class="toctree-wrapper compound">
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Database Handlers:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="autodelete.html">AutoDelete Database</a><ul>
<li class="toctree-l2"><a class="reference internal" href="autodelete.html#DevTools.backend.database.autodelete_db.AutoDeleteDB"><code class="docutils literal notranslate"><span class="pre">AutoDeleteDB</span></code></a></li>
</ul>
</li>
</ul>
</div>
<section id="database-overview">
<h2>Database Overview<a class="headerlink" href="#database-overview" title="Link to this heading">#</a></h2>
Expand Down Expand Up @@ -880,15 +871,6 @@ <h3>Access Location<a class="headerlink" href="#access-location" title="Link to
<p class="prev-next-title">Contributing to ManagerX</p>
</div>
</a>
<a class="right-next"
href="autodelete.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">AutoDelete Database</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>

Expand Down
90 changes: 2 additions & 88 deletions docs/_build/html/dev_guide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -296,8 +296,7 @@
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="contributing/index.html">Contributing</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="database/index.html">database</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="database/autodelete.html">AutoDelete Database</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="database/index.html">Database</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="simple">
</ul>
</details></li>
</ul>
Expand Down Expand Up @@ -360,76 +359,6 @@
<section id="developer-guide">
<h1>Developer Guide<a class="headerlink" href="#developer-guide" title="Link to this heading">#</a></h1>
<p>Welcome to the ManagerX Developer Guide! This section provides in-depth information for developers looking to contribute to or extend ManagerX, including architecture overviews, API references, and development best practices.</p>
<p>To download and set up the development environment, follow these steps:
1. Clone the ManagerX repository from GitHub:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/Oppro-net-Development/ManagerX.git
</pre></div>
</div>
<ol class="arabic simple" start="2">
<li><p>Navigate to the project directory:</p></li>
</ol>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>ManagerX
</pre></div>
</div>
<ol class="arabic simple" start="3">
<li><p>Install the required dependencies:</p></li>
</ol>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>req.txt
</pre></div>
</div>
<div class="admonition-note admonition">
<p class="admonition-title">note</p>
<p>Ensure you have Python 3.10 or higher installed to run ManagerX successfully.</p>
</div>
</section>
<section id="dependencies">
<h1>Dependencies<a class="headerlink" href="#dependencies" title="Link to this heading">#</a></h1>
<p>The following dependencies are required for developing and running ManagerX:</p>
<ul class="simple">
<li><p>Python 3.10+</p></li>
<li><p>aiocache</p></li>
<li><p>aiohappyeyeballs</p></li>
<li><p>aiohttp</p></li>
<li><p>aiosqlite</p></li>
<li><p>annotated-types</p></li>
<li><p>anyio</p></li>
<li><p>attrs</p></li>
<li><p>beautifulsoup4</p></li>
<li><p>certifi</p></li>
<li><p>charset-normalizer</p></li>
<li><p>click</p></li>
<li><p>colorama</p></li>
<li><p>ezcord</p></li>
<li><p>frozenlist</p></li>
<li><p>h11</p></li>
<li><p>idna</p></li>
<li><p>Jinja2</p></li>
<li><p>MarkupSafe</p></li>
<li><p>multidict</p></li>
<li><p>propcache</p></li>
<li><p>py-cord==2.7.0rc2</p></li>
<li><p>pydantic</p></li>
<li><p>pydantic_core</p></li>
<li><p>python-dotenv</p></li>
<li><p>PyYAML</p></li>
<li><p>requests</p></li>
<li><p>six</p></li>
<li><p>sniffio</p></li>
<li><p>soupsieve</p></li>
<li><p>starlette</p></li>
<li><p>typing_extensions</p></li>
<li><p>typing-inspection</p></li>
<li><p>urllib3</p></li>
<li><p>wikipedia</p></li>
<li><p>yarl</p></li>
<li><p>timedelta</p></li>
<li><p>sphinx</p></li>
<li><p>pydata-sphinx-theme</p></li>
<li><p>sphinx-autodoc-typehints</p></li>
<li><p>myst-parser</p></li>
<li><p>SimpleColoredLogs – Another Project of OPPRO.NET Development</p></li>
<li><p>sphinx-copybutton</p></li>
</ul>
<div class="toctree-wrapper compound">
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Developer Guide:</span></p>
<ul>
Expand All @@ -446,8 +375,7 @@ <h1>Dependencies<a class="headerlink" href="#dependencies" title="Link to this h
<li class="toctree-l2"><a class="reference internal" href="contributing/index.html#community-guidelines">Community Guidelines</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="database/index.html">database</a><ul>
<li class="toctree-l2"><a class="reference internal" href="database/autodelete.html">AutoDelete Database</a></li>
<li class="toctree-l1"><a class="reference internal" href="database/index.html">Database</a><ul>
<li class="toctree-l2"><a class="reference internal" href="database/index.html#database-overview">Database Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="database/index.html#detailed-database-documentation">Detailed Database Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="database/index.html#database-patterns-and-best-practices">Database Patterns and Best Practices</a></li>
Expand Down Expand Up @@ -496,20 +424,6 @@ <h1>Dependencies<a class="headerlink" href="#dependencies" title="Link to this h
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">


<div class="sidebar-secondary-item">
<div
id="pst-page-navigation-heading-2"
class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
<ul class="visible nav section-nav flex-column">
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#">Developer Guide</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#dependencies">Dependencies</a></li>
</ul>

</nav></div>

<div class="sidebar-secondary-item">
<div role="note" aria-label="source link">
<h3>This Page</h3>
Expand Down
Loading