Skip to content

Commit 2dbc35e

Browse files
Medicopter117Medicopter117
authored
Merge pull request #25 from Oppro-net-Development/1.7.2-site
V1.7.2 Site
2 parents 968246d + f8db74f commit 2dbc35e

27 files changed

Lines changed: 1693 additions & 280 deletions

File tree

‎docs/_build/html/dev_guide/architecture/cog_system.html‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@
4747
<script>DOCUMENTATION_OPTIONS.pagename = 'dev_guide/architecture/cog_system';</script>
4848
<link rel="index" title="Index" href="../../genindex.html" />
4949
<link rel="search" title="Search" href="../../search.html" />
50-
<link rel="next" title="&lt;no title&gt;" href="logging_system.html" />
51-
<link rel="prev" title="&lt;no title&gt;" href="database_handler.html" />
50+
<link rel="next" title="Logging System" href="logging_system.html" />
51+
<link rel="prev" title="Database Handler" href="database_handler.html" />
5252
<meta name="viewport" content="width=device-width, initial-scale=1"/>
5353
<meta name="docsearch:language" content="en"/>
5454
<meta name="docsearch:version" content="1.7" />
@@ -288,10 +288,15 @@
288288
<div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">Developer Guide:</span></p>
289289
<ul class="current nav bd-sidenav">
290290
<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">
291-
<li class="toctree-l2"><a class="reference internal" href="command_handler.html">Slash Command Handler for ManagerX</a></li>
292-
293-
291+
<li class="toctree-l2"><a class="reference internal" href="event_loop.html">Event Loop</a></li>
292+
<li class="toctree-l2"><a class="reference internal" href="command_handler.html">Command Handler</a></li>
293+
<li class="toctree-l2"><a class="reference internal" href="database_handler.html">Database Handler</a></li>
294294
<li class="toctree-l2 current active"><a class="current reference internal" href="#">Cog System</a></li>
295+
<li class="toctree-l2"><a class="reference internal" href="logging_system.html">Logging System</a></li>
296+
</ul>
297+
</details></li>
298+
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
299+
<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">
295300
</ul>
296301
</details></li>
297302
</ul>
@@ -544,15 +549,15 @@ <h2>Best Practices<a class="headerlink" href="#best-practices" title="Link to th
544549
<i class="fa-solid fa-angle-left"></i>
545550
<div class="prev-next-info">
546551
<p class="prev-next-subtitle">previous</p>
547-
<p class="prev-next-title">&lt;no title&gt;</p>
552+
<p class="prev-next-title">Database Handler</p>
548553
</div>
549554
</a>
550555
<a class="right-next"
551556
href="logging_system.html"
552557
title="next page">
553558
<div class="prev-next-info">
554559
<p class="prev-next-subtitle">next</p>
555-
<p class="prev-next-title">&lt;no title&gt;</p>
560+
<p class="prev-next-title">Logging System</p>
556561
</div>
557562
<i class="fa-solid fa-angle-right"></i>
558563
</a>

‎docs/_build/html/dev_guide/architecture/command_handler.html‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@
4747
<script>DOCUMENTATION_OPTIONS.pagename = 'dev_guide/architecture/command_handler';</script>
4848
<link rel="index" title="Index" href="../../genindex.html" />
4949
<link rel="search" title="Search" href="../../search.html" />
50-
<link rel="next" title="&lt;no title&gt;" href="database_handler.html" />
51-
<link rel="prev" title="&lt;no title&gt;" href="event_loop.html" />
50+
<link rel="next" title="Database Handler" href="database_handler.html" />
51+
<link rel="prev" title="Event Loop" href="event_loop.html" />
5252
<meta name="viewport" content="width=device-width, initial-scale=1"/>
5353
<meta name="docsearch:language" content="en"/>
5454
<meta name="docsearch:version" content="1.7" />
@@ -288,8 +288,15 @@
288288
<div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">Developer Guide:</span></p>
289289
<ul class="current nav bd-sidenav">
290290
<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">
291+
<li class="toctree-l2"><a class="reference internal" href="event_loop.html">Event Loop</a></li>
291292
<li class="toctree-l2 current active"><a class="current reference internal" href="#">Command Handler</a></li>
293+
<li class="toctree-l2"><a class="reference internal" href="database_handler.html">Database Handler</a></li>
292294
<li class="toctree-l2"><a class="reference internal" href="cog_system.html">Cog System</a></li>
295+
<li class="toctree-l2"><a class="reference internal" href="logging_system.html">Logging System</a></li>
296+
</ul>
297+
</details></li>
298+
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
299+
<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">
293300
</ul>
294301
</details></li>
295302
</ul>
@@ -441,15 +448,15 @@ <h2>2. Features Demonstrated<a class="headerlink" href="#features-demonstrated"
441448
<i class="fa-solid fa-angle-left"></i>
442449
<div class="prev-next-info">
443450
<p class="prev-next-subtitle">previous</p>
444-
<p class="prev-next-title">&lt;no title&gt;</p>
451+
<p class="prev-next-title">Event Loop</p>
445452
</div>
446453
</a>
447454
<a class="right-next"
448455
href="database_handler.html"
449456
title="next page">
450457
<div class="prev-next-info">
451458
<p class="prev-next-subtitle">next</p>
452-
<p class="prev-next-title">&lt;no title&gt;</p>
459+
<p class="prev-next-title">Database Handler</p>
453460
</div>
454461
<i class="fa-solid fa-angle-right"></i>
455462
</a>

‎docs/_build/html/dev_guide/architecture/database_handler.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,10 @@
295295
<li class="toctree-l2"><a class="reference internal" href="logging_system.html">Logging System</a></li>
296296
</ul>
297297
</details></li>
298+
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
299+
<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">
300+
</ul>
301+
</details></li>
298302
</ul>
299303
</div>
300304
</nav></div>

‎docs/_build/html/dev_guide/architecture/event_loop.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,10 @@
295295
<li class="toctree-l2"><a class="reference internal" href="logging_system.html">Logging System</a></li>
296296
</ul>
297297
</details></li>
298+
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
299+
<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">
300+
</ul>
301+
</details></li>
298302
</ul>
299303
</div>
300304
</nav></div>

‎docs/_build/html/dev_guide/architecture/index.html‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -296,8 +296,7 @@
296296
</ul>
297297
</details></li>
298298
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
299-
<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>
300-
<li class="toctree-l2"><a class="reference internal" href="../database/autodelete.html">AutoDelete Database</a></li>
299+
<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">
301300
</ul>
302301
</details></li>
303302
</ul>

‎docs/_build/html/dev_guide/architecture/logging_system.html‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@
4747
<script>DOCUMENTATION_OPTIONS.pagename = 'dev_guide/architecture/logging_system';</script>
4848
<link rel="index" title="Index" href="../../genindex.html" />
4949
<link rel="search" title="Search" href="../../search.html" />
50+
<link rel="next" title="Contributing to ManagerX" href="../contributing/index.html" />
5051
<link rel="prev" title="Cog System" href="cog_system.html" />
5152
<meta name="viewport" content="width=device-width, initial-scale=1"/>
5253
<meta name="docsearch:language" content="en"/>
@@ -294,6 +295,10 @@
294295
<li class="toctree-l2 current active"><a class="current reference internal" href="#">Logging System</a></li>
295296
</ul>
296297
</details></li>
298+
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
299+
<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">
300+
</ul>
301+
</details></li>
297302
</ul>
298303
</div>
299304
</nav></div>
@@ -408,6 +413,15 @@ <h2>Conclusion<a class="headerlink" href="#conclusion" title="Link to this headi
408413
<p class="prev-next-title">Cog System</p>
409414
</div>
410415
</a>
416+
<a class="right-next"
417+
href="../contributing/index.html"
418+
title="next page">
419+
<div class="prev-next-info">
420+
<p class="prev-next-subtitle">next</p>
421+
<p class="prev-next-title">Contributing to ManagerX</p>
422+
</div>
423+
<i class="fa-solid fa-angle-right"></i>
424+
</a>
411425
</div>
412426
</footer>
413427

‎docs/_build/html/dev_guide/contributing/index.html‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
<script>DOCUMENTATION_OPTIONS.pagename = 'dev_guide/contributing/index';</script>
4848
<link rel="index" title="Index" href="../../genindex.html" />
4949
<link rel="search" title="Search" href="../../search.html" />
50-
<link rel="next" title="Testing ManagerX" href="../testing/index.html" />
50+
<link rel="next" title="Database &amp; Database Handler" href="../database/index.html" />
5151
<link rel="prev" title="Logging System" href="../architecture/logging_system.html" />
5252
<meta name="viewport" content="width=device-width, initial-scale=1"/>
5353
<meta name="docsearch:language" content="en"/>
@@ -296,8 +296,7 @@
296296
</ul>
297297
</details></li>
298298
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Contributing</a></li>
299-
<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>
300-
<li class="toctree-l2"><a class="reference internal" href="../testing/unit_testing/index.html">Unit Testing</a></li>
299+
<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">
301300
</ul>
302301
</details></li>
303302
</ul>
@@ -432,11 +431,11 @@ <h2>Community Guidelines<a class="headerlink" href="#community-guidelines" title
432431
</div>
433432
</a>
434433
<a class="right-next"
435-
href="../testing/index.html"
434+
href="../database/index.html"
436435
title="next page">
437436
<div class="prev-next-info">
438437
<p class="prev-next-subtitle">next</p>
439-
<p class="prev-next-title">Testing ManagerX</p>
438+
<p class="prev-next-title">Database &amp; Database Handler</p>
440439
</div>
441440
<i class="fa-solid fa-angle-right"></i>
442441
</a>

‎docs/_build/html/dev_guide/database/index.html‎

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@
4747
<script>DOCUMENTATION_OPTIONS.pagename = 'dev_guide/database/index';</script>
4848
<link rel="index" title="Index" href="../../genindex.html" />
4949
<link rel="search" title="Search" href="../../search.html" />
50-
<link rel="next" title="AutoDelete Database" href="autodelete.html" />
5150
<link rel="prev" title="Contributing to ManagerX" href="../contributing/index.html" />
5251
<meta name="viewport" content="width=device-width, initial-scale=1"/>
5352
<meta name="docsearch:language" content="en"/>
@@ -296,8 +295,7 @@
296295
</ul>
297296
</details></li>
298297
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
299-
<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>
300-
<li class="toctree-l2"><a class="reference internal" href="autodelete.html">AutoDelete Database</a></li>
298+
<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">
301299
</ul>
302300
</details></li>
303301
</ul>
@@ -364,13 +362,6 @@
364362
<h1>Database &amp; Database Handler<a class="headerlink" href="#database-database-handler" title="Link to this heading">#</a></h1>
365363
<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>
366364
<div class="toctree-wrapper compound">
367-
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Database Handlers:</span></p>
368-
<ul>
369-
<li class="toctree-l1"><a class="reference internal" href="autodelete.html">AutoDelete Database</a><ul>
370-
<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>
371-
</ul>
372-
</li>
373-
</ul>
374365
</div>
375366
<section id="database-overview">
376367
<h2>Database Overview<a class="headerlink" href="#database-overview" title="Link to this heading">#</a></h2>
@@ -880,15 +871,6 @@ <h3>Access Location<a class="headerlink" href="#access-location" title="Link to
880871
<p class="prev-next-title">Contributing to ManagerX</p>
881872
</div>
882873
</a>
883-
<a class="right-next"
884-
href="autodelete.html"
885-
title="next page">
886-
<div class="prev-next-info">
887-
<p class="prev-next-subtitle">next</p>
888-
<p class="prev-next-title">AutoDelete Database</p>
889-
</div>
890-
<i class="fa-solid fa-angle-right"></i>
891-
</a>
892874
</div>
893875
</footer>
894876

‎docs/_build/html/dev_guide/index.html‎

Lines changed: 2 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -296,8 +296,7 @@
296296
</ul>
297297
</details></li>
298298
<li class="toctree-l1"><a class="reference internal" href="contributing/index.html">Contributing</a></li>
299-
<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>
300-
<li class="toctree-l2"><a class="reference internal" href="database/autodelete.html">AutoDelete Database</a></li>
299+
<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">
301300
</ul>
302301
</details></li>
303302
</ul>
@@ -360,76 +359,6 @@
360359
<section id="developer-guide">
361360
<h1>Developer Guide<a class="headerlink" href="#developer-guide" title="Link to this heading">#</a></h1>
362361
<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>
363-
<p>To download and set up the development environment, follow these steps:
364-
1. Clone the ManagerX repository from GitHub:</p>
365-
<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
366-
</pre></div>
367-
</div>
368-
<ol class="arabic simple" start="2">
369-
<li><p>Navigate to the project directory:</p></li>
370-
</ol>
371-
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>ManagerX
372-
</pre></div>
373-
</div>
374-
<ol class="arabic simple" start="3">
375-
<li><p>Install the required dependencies:</p></li>
376-
</ol>
377-
<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
378-
</pre></div>
379-
</div>
380-
<div class="admonition-note admonition">
381-
<p class="admonition-title">note</p>
382-
<p>Ensure you have Python 3.10 or higher installed to run ManagerX successfully.</p>
383-
</div>
384-
</section>
385-
<section id="dependencies">
386-
<h1>Dependencies<a class="headerlink" href="#dependencies" title="Link to this heading">#</a></h1>
387-
<p>The following dependencies are required for developing and running ManagerX:</p>
388-
<ul class="simple">
389-
<li><p>Python 3.10+</p></li>
390-
<li><p>aiocache</p></li>
391-
<li><p>aiohappyeyeballs</p></li>
392-
<li><p>aiohttp</p></li>
393-
<li><p>aiosqlite</p></li>
394-
<li><p>annotated-types</p></li>
395-
<li><p>anyio</p></li>
396-
<li><p>attrs</p></li>
397-
<li><p>beautifulsoup4</p></li>
398-
<li><p>certifi</p></li>
399-
<li><p>charset-normalizer</p></li>
400-
<li><p>click</p></li>
401-
<li><p>colorama</p></li>
402-
<li><p>ezcord</p></li>
403-
<li><p>frozenlist</p></li>
404-
<li><p>h11</p></li>
405-
<li><p>idna</p></li>
406-
<li><p>Jinja2</p></li>
407-
<li><p>MarkupSafe</p></li>
408-
<li><p>multidict</p></li>
409-
<li><p>propcache</p></li>
410-
<li><p>py-cord==2.7.0rc2</p></li>
411-
<li><p>pydantic</p></li>
412-
<li><p>pydantic_core</p></li>
413-
<li><p>python-dotenv</p></li>
414-
<li><p>PyYAML</p></li>
415-
<li><p>requests</p></li>
416-
<li><p>six</p></li>
417-
<li><p>sniffio</p></li>
418-
<li><p>soupsieve</p></li>
419-
<li><p>starlette</p></li>
420-
<li><p>typing_extensions</p></li>
421-
<li><p>typing-inspection</p></li>
422-
<li><p>urllib3</p></li>
423-
<li><p>wikipedia</p></li>
424-
<li><p>yarl</p></li>
425-
<li><p>timedelta</p></li>
426-
<li><p>sphinx</p></li>
427-
<li><p>pydata-sphinx-theme</p></li>
428-
<li><p>sphinx-autodoc-typehints</p></li>
429-
<li><p>myst-parser</p></li>
430-
<li><p>SimpleColoredLogs – Another Project of OPPRO.NET Development</p></li>
431-
<li><p>sphinx-copybutton</p></li>
432-
</ul>
433362
<div class="toctree-wrapper compound">
434363
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Developer Guide:</span></p>
435364
<ul>
@@ -446,8 +375,7 @@ <h1>Dependencies<a class="headerlink" href="#dependencies" title="Link to this h
446375
<li class="toctree-l2"><a class="reference internal" href="contributing/index.html#community-guidelines">Community Guidelines</a></li>
447376
</ul>
448377
</li>
449-
<li class="toctree-l1"><a class="reference internal" href="database/index.html">database</a><ul>
450-
<li class="toctree-l2"><a class="reference internal" href="database/autodelete.html">AutoDelete Database</a></li>
378+
<li class="toctree-l1"><a class="reference internal" href="database/index.html">Database</a><ul>
451379
<li class="toctree-l2"><a class="reference internal" href="database/index.html#database-overview">Database Overview</a></li>
452380
<li class="toctree-l2"><a class="reference internal" href="database/index.html#detailed-database-documentation">Detailed Database Documentation</a></li>
453381
<li class="toctree-l2"><a class="reference internal" href="database/index.html#database-patterns-and-best-practices">Database Patterns and Best Practices</a></li>
@@ -496,20 +424,6 @@ <h1>Dependencies<a class="headerlink" href="#dependencies" title="Link to this h
496424
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
497425

498426

499-
<div class="sidebar-secondary-item">
500-
<div
501-
id="pst-page-navigation-heading-2"
502-
class="page-toc tocsection onthispage">
503-
<i class="fa-solid fa-list"></i> On this page
504-
</div>
505-
<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
506-
<ul class="visible nav section-nav flex-column">
507-
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#">Developer Guide</a></li>
508-
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#dependencies">Dependencies</a></li>
509-
</ul>
510-
511-
</nav></div>
512-
513427
<div class="sidebar-secondary-item">
514428
<div role="note" aria-label="source link">
515429
<h3>This Page</h3>

0 commit comments

Comments
 (0)