.. _getdocs:
=======
GetDocs
=======

This is the cog guide for the ``GetDocs`` cog. This guide contains the collection of commands which you can use in the cog.
Through this guide, ``[p]`` will always represent your prefix. Replace ``[p]`` with your own prefix when you use these commands in Discord.

.. note::

    Ensure that you are up to date by running ``[p]cog update getdocs``.
    If there is something missing, or something that needs improving in this documentation, feel free to create an issue `here <https://github.com/AAA3A-AAA3A/AAA3A-cogs/issues>`_.
    This documentation is generated everytime this cog receives an update.

---------------
About this cog:
---------------

A cog to get and display some documentations in Discord! Use `[p]listsources` to get a list of all the available sources.

---------
Commands:
---------

Here are all the commands included in this cog (13):

* ``[p]docs [source] [query]``
 View rich documentation for a specific node/query.

* ``[p]listsources [_sorted=False] ["available"|"all"|"disabled"=available]``
 Shows a list of all sources, those that are available or those that are disabled.

* ``[p]rtfm [source] [query] [limit=10] [with_std=False]``
 Show all items matching your search.

* ``[p]setgetdocs``
 Commands to configure GetDocs.

* ``[p]setgetdocs caching <caching>``
 Enable or disable Documentations caching when loading the cog.

* ``[p]setgetdocs defaultsource <default_source>``
 Set the documentations source.

* ``[p]setgetdocs disablesources [sources]...``
 Disable Documentations source(s).

* ``[p]setgetdocs enablesources [sources]...``
 Enable Documentations source(s).

* ``[p]setgetdocs getdebugloopstatus``
 Get an embed to check loop status.

* ``[p]setgetdocs modalconfig [confirmation=False]``
 Set all settings for the cog with a Discord Modal.

* ``[p]setgetdocs resetsetting <setting>``
 Reset a setting.

* ``[p]setgetdocs showsettings [with_dev=False]``
 Show all settings for the cog with defaults and values.

* ``[p]setgetdocs stats``
 Show stats about all documentations sources.

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

If you haven't added my repo before, lets add it first. We'll call it "AAA3A-cogs" here.

.. code-block:: ini

    [p]repo add AAA3A-cogs https://github.com/AAA3A-AAA3A/AAA3A-cogs

Now, we can install GetDocs.

.. code-block:: ini

    [p]cog install AAA3A-cogs getdocs

Once it's installed, it is not loaded by default. Load it by running the following command:

.. code-block:: ini

    [p]load getdocs

----------------
Further Support:
----------------

Check out my docs `here <https://aaa3a-cogs.readthedocs.io/en/latest/>`_.
Mention me in the #support_other-cogs in the `cog support server <https://discord.gg/GET4DVk>`_ if you need any help.
Additionally, feel free to open an issue or pull request to this repo.

--------
Credits:
--------

Thanks to Kreusada for the Python code to automatically generate this documentation!