Skip to content

Commit

Permalink
docs: dgw last edit (or is it?)
Browse files Browse the repository at this point in the history
Co-authored-by: dgw <dgw@technobabbl.es>
  • Loading branch information
Exirel and dgw authored Nov 25, 2023
1 parent 0faf0b8 commit 791695f
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/source/run.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ your plugins and your configuration.
run/cli
run/configuration

.. __: https://github.com/sopel-irc/sopel/
.. __: https://github.com/sopel-irc/sopel
2 changes: 1 addition & 1 deletion docs/source/run/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ can create with the following command::

This will run a wizard that helps you create a configuration file. It will
ask you questions to fill in the details. When you see something in ``[square
brackets]``, that's the default setting, and you can just hit Enter to keep
brackets]``, that's the default setting, and you can just hit :kbd:`Enter` to keep
it. We recommend selecting a custom nick for your bot during configuration.

This wizard doesn't cover every option, only the ones which are needed to get
Expand Down
18 changes: 14 additions & 4 deletions docs/source/run/plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,21 +99,28 @@ By default, all plugins are enabled, and you disable plugins one by one.
However, you may want to enable only a set of plugins, and disable every other
one by default.

To do so, the enable command has a ``--allow-only`` option: this will add the
plugin to the :attr:`~sopel.config.core_section.CoreSection.enable` list::
The ``enable`` command has an ``--allow-only`` option. For example, to add the
``remind`` plugin to the :attr:`~sopel.config.core_section.CoreSection.enable`
list, you would use this command line::

sopel-plugins enable --allow-only remind

When you start the bot (or restart), the bot will load the plugins from the
``enable`` list, and **only these plugins**.

.. note::

You only need to use the ``--enable-only`` option once. If the ``enable``
list is not empty, ``sopel-plugins enable`` and ``sopel-plugins disable``
will add and remove plugins in that list.


Configuring plugins
===================

Some (but not all!) plugins define their own configuration sections so you can
configure their behavior. If a plugin supports it, you may be able to use the
configuration wizard to edit the configuration of the plugin::
configuration wizard to do this::

sopel-plugins configure remind

Expand All @@ -134,4 +141,7 @@ example configuration of the `sopel-remind plugin`__, which defines the
# remind's section
location = /path/to/remind/location
Sopel must be restarted after making changes to the configuration file.
.. important::

Sopel must be restarted after making changes to the configuration file.

2 changes: 1 addition & 1 deletion docs/source/run/service.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Running as a service
====================

Now that you can run the bot, you probably want it to run forever in the
Once you have your bot set up, you will probably want it to run forever in the
background of your system. While there are many ways to do so, there are a few
steps and requirements that remain the same to properly run Sopel as a service.

Expand Down

0 comments on commit 791695f

Please sign in to comment.