Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Malarne committed Apr 15, 2019
1 parent 4e0f86e commit 4c7a863
Show file tree
Hide file tree
Showing 9 changed files with 173 additions and 7 deletions.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/leveler.doctree
Binary file not shown.
29 changes: 27 additions & 2 deletions docs/_build/html/_sources/leveler.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Finally, you can install the cog::
[p]load Leveler

-----
Usage
Configuration commands
-----

First of all, the channel whitelist is enabled by default.
Expand Down Expand Up @@ -123,4 +123,29 @@ Check out the config commands to set up your cog correctly.

* ``[p]levelerset setxp <xp> <user>``
This will set <user>'s xp to <xp>
Note that settting xp to a really high value can throw errors.
Note that settting xp to a really high value can throw errors.


-----
Usage
-----

* ``[p]profileset``
Profile customization base command.

* ``[p]profileset background <url>``
Allow you to change your profile background to the image you want.
Just note that it only accepts url for security reasons.

* ``[p]profileset description <description>``
Allow you to add a description to your profile.

* ``[p]register``
Allow user to start gaining xp.
Note that it's not needed if you turned on autoregister setting.

* ``[p]profile [user]``
Show your or user (if provided)'s profile.

* ``[p]toplevel``
Show the 9 highest members of your server and how many messages they sent today !
1 change: 1 addition & 0 deletions docs/_build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ <h1>Welcome to AyDocs’s documentation!<a class="headerlink" href="#welcome-to-
<ul>
<li class="toctree-l1"><a class="reference internal" href="leveler.html">Leveler</a><ul>
<li class="toctree-l2"><a class="reference internal" href="leveler.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="leveler.html#configuration-commands">Configuration commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="leveler.html#usage">Usage</a></li>
</ul>
</li>
Expand Down
46 changes: 44 additions & 2 deletions docs/_build/html/leveler.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Leveler</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#configuration-commands">Configuration commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="#usage">Usage</a></li>
</ul>
</li>
Expand Down Expand Up @@ -179,8 +180,8 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
</div>
</div>
</div>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline"></a></h2>
<div class="section" id="configuration-commands">
<h2>Configuration commands<a class="headerlink" href="#configuration-commands" title="Permalink to this headline"></a></h2>
<p>First of all, the channel whitelist is enabled by default.
Check out the config commands to set up your cog correctly.</p>
<ul class="simple">
Expand Down Expand Up @@ -349,6 +350,47 @@ <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">[p]profileset</span></code></p></li>
</ul>
<blockquote>
<div><p>Profile customization base command.</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">[p]profileset</span> <span class="pre">background</span> <span class="pre">&lt;url&gt;</span></code></p></li>
</ul>
<blockquote>
<div><p>Allow you to change your profile background to the image you want.
Just note that it only accepts url for security reasons.</p>
</div></blockquote>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">[p]profileset</span> <span class="pre">description</span> <span class="pre">&lt;description&gt;</span></code></p></li>
</ul>
<blockquote>
<div><p>Allow you to add a description to your profile.</p>
</div></blockquote>
</div></blockquote>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">[p]register</span></code></p></li>
</ul>
<blockquote>
<div><p>Allow user to start gaining xp.
Note that it’s not needed if you turned on autoregister setting.</p>
</div></blockquote>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">[p]profile</span> <span class="pre">[user]</span></code></p></li>
</ul>
<blockquote>
<div><p>Show your or user (if provided)’s profile.</p>
</div></blockquote>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">[p]toplevel</span></code></p></li>
</ul>
<blockquote>
<div><p>Show the 9 highest members of your server and how many messages they sent today !</p>
</div></blockquote>
</div>
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

31 changes: 31 additions & 0 deletions docs/league.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
==========
League
==========

This is the guide for ``League`` cog.
Be sure to have the latest version of the cog first, using ``[p]cog update`` before reading this.
``[p]`` being your bot's prefix

------------
Installation
------------

To install the cog, first load the downloader cog, included
in core Red.::

[p]load downloader

Then you will need to install my repository::

[p]repo add Malarne https://github.com/Malarne/discord_cogs

Finally, you can install the cog::

[p]cog install Malarne League

.. warning:: The cog is not loaded by default.
To load it, type this::

[p]load League


29 changes: 27 additions & 2 deletions docs/leveler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Finally, you can install the cog::
[p]load Leveler

-----
Usage
Configuration commands
-----

First of all, the channel whitelist is enabled by default.
Expand Down Expand Up @@ -123,4 +123,29 @@ Check out the config commands to set up your cog correctly.

* ``[p]levelerset setxp <xp> <user>``
This will set <user>'s xp to <xp>
Note that settting xp to a really high value can throw errors.
Note that settting xp to a really high value can throw errors.


-----
Usage
-----

* ``[p]profileset``
Profile customization base command.

* ``[p]profileset background <url>``
Allow you to change your profile background to the image you want.
Just note that it only accepts url for security reasons.

* ``[p]profileset description <description>``
Allow you to add a description to your profile.

* ``[p]register``
Allow user to start gaining xp.
Note that it's not needed if you turned on autoregister setting.

* ``[p]profile [user]``
Show your or user (if provided)'s profile.

* ``[p]toplevel``
Show the 9 highest members of your server and how many messages they sent today !
42 changes: 42 additions & 0 deletions docs/oboobs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
==========
oBoobs
==========

This is the guide for ``oBoobs`` cog.
Be sure to have the latest version of the cog first, using ``[p]cog update`` before reading this.
``[p]`` being your bot's prefix

------------
Installation
------------

To install the cog, first load the downloader cog, included
in core Red.::

[p]load downloader

Then you will need to install my repository::

[p]repo add Malarne https://github.com/Malarne/discord_cogs

Finally, you can install the cog::

[p]cog install Malarne oBoobs

.. warning:: The cog is not loaded by default.
To load it, type this::

[p]load oBoobs


-----
Usage
-----

First of all, this cog's commands will only work on nsfw channels !

* ``[p]ass``
Show an ass pic.

* ``[p]boobs``
Show a boobs pic.

0 comments on commit 4c7a863

Please sign in to comment.