[V3 Docs] Started instantcommands

laggron42 · May 23, 2018 · 73983a6 · 73983a6
1 parent 43561ee
commit 73983a6
Show file tree

Hide file tree

Showing 7 changed files with 294 additions and 1 deletion.
diff --git a/docs/.build/html/.doctrees/environment.pickle b/docs/.build/html/.doctrees/environment.pickle
diff --git a/docs/.build/html/.doctrees/instantcommands.doctree b/docs/.build/html/.doctrees/instantcommands.doctree
diff --git a/docs/.build/html/_sources/instantcommands.rst.txt b/docs/.build/html/_sources/instantcommands.rst.txt
diff --git a/docs/.build/html/instantcommands.html b/docs/.build/html/instantcommands.html
@@ -0,0 +1,209 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <title>&lt;no title&gt; &mdash; Laggron&#39;s Dumb Cogs  documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" /> 
+
+
+  <script src="_static/js/modernizr.min.js"></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"> Laggron's Dumb Cogs
+
+
+
+          </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" />
+    <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="main navigation">
+
+
+
+
+
+
+              <p class="caption"><span class="caption-text">Cog guides:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="say.html">Say</a></li>
+<li class="toctree-l1"><a class="reference internal" href="roleinvite.html">RoleInvite</a></li>
+</ul>
+
+
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+      <nav class="wy-nav-top" aria-label="top navigation">
+
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">Laggron's Dumb Cogs</a>
+
+      </nav>
+
+
+      <div class="wy-nav-content">
+
+        <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+
+      <li><a href="index.html">Docs</a> &raquo;</li>
+
+      <li>&lt;no title&gt;</li>
+
+
+      <li class="wy-breadcrumbs-aside">
+
+
+            <a href="_sources/instantcommands.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">
+
+
+
+           </div>
+
+          </div>
+          <footer>
+
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2018, El Laggron.
+
+    </p>
+  </div>
+  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+
+
+
+
+
+    <script type="text/javascript">
+        var DOCUMENTATION_OPTIONS = {
+            URL_ROOT:'./',
+            VERSION:'',
+            LANGUAGE:'None',
+            COLLAPSE_INDEX:false,
+            FILE_SUFFIX:'.html',
+            HAS_SOURCE:  true,
+            SOURCELINK_SUFFIX: '.txt'
+        };
+    </script>
+      <script type="text/javascript" src="_static/jquery.js"></script>
+      <script type="text/javascript" src="_static/underscore.js"></script>
+      <script type="text/javascript" src="_static/doctools.js"></script>
+      <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+
+
+
+
+
+    <script type="text/javascript" src="_static/js/theme.js"></script>
+
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/docs/.build/html/objects.inv b/docs/.build/html/objects.inv
diff --git a/docs/.build/html/searchindex.js b/docs/.build/html/searchindex.js
diff --git a/docs/instantcommands.rst b/docs/instantcommands.rst
@@ -0,0 +1,84 @@
+===============
+InstantCommands
+===============
+
+.. note:: These docs refers to the **beta 2b** version. 
+    Make sure you're under the good version by typing ``[p]cog update``.
+
+This is the guide for the ``instantcmd`` cog. Everything you need is here.
+
+``[p]`` is considered as your prefix.
+
+------------
+Installation
+------------
+
+To install the cog, first load the downloader cog, included
+in core Red.::
+
+    [p]load downloader
+
+Then you will need to install the Laggron's Dumb Cogs repository::
+
+    [p]repo add Laggrons-Dumb-Cogs https://github.com/retke/Laggrons-Dumb-Cogs v3
+
+Finally, you can install the cog::
+
+    [p]cog install Laggrons-Dumb-Cogs instantcmd
+
+.. warning:: The cog is not loaded by default. 
+    To load it, type this::
+
+        [p]load instantcmd
+
+-----
+Usage
+-----
+
+InstantCommands is designed to create new commands and listeners directly 
+from Discord. You just need basic Python and discord.py knowledge.
+
+Here's an example of his it works:
+
+.. image:: .ressources/EXAMPLES/InstantCommands-example.png
+
+Here's a list of all commands of this cog:
+
+~~~~~~~~~~~~~~
+instantcommand
+~~~~~~~~~~~~~~
+
+**Syntax**::
+
+    [p][instacmd|instantcmd|instantcommand]
+
+**Description**
+
+This is the main command used for setting up the code. 
+It will be used for all other commands.
+
+~~~~~~~~~~~~~~~~~~~~~
+instantcommand create
+~~~~~~~~~~~~~~~~~~~~~
+
+**Syntax**::
+
+    [p]instantcommand create
+
+**Description**
+
+Creates a new command/listener from a code snippet.
+
+You will be asked to give a code snippet which will contain your function. 
+It can be a command (you will need to add the ``commands`` decorator) or a listener 
+(your function name must correspond to an existing discord.py listener).
+
+.. tip:: Here are some examples ::
+
+    @roleset.command()
+    @commands.command()
+    async def command(ctx, *, argument):
+        """Say your text with some magic"""
+
+        await ctx.send("You excepted to see your text, "
+                        "but it was I, Dio!")