christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2025-02-14 06:40:21 +00:00
Code Issues Releases Activity

squash: docs: grammar, typos

Browse Source
This commit is contained in:
Kyle McCormick 2022-03-04 17:11:14 -05:00 committed by Régis Behmo
parent 0d2d6c58e8
commit 38a67e6c64
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/plugins/api.rst
View File

@ -1,7 +1,7 @@
Plugin API
==========
Plugins can affect the behaviour of Tutor at multiple levels:
Plugins can affect the behaviour of Tutor at multiple levels. They can:
* Add new settings or modify existing ones in the Tutor configuration (see :ref:`config <plugin_config>`).
* Add new templates to the Tutor project environment or modify existing ones (see :ref:`patches <plugin_patches>`, :ref:`templates <plugin_templates>` and :ref:`hooks <plugin_hooks>`).
@ -9,6 +9,7 @@ Plugins can affect the behaviour of Tutor at multiple levels:
There exists two different APIs to create Tutor plugins: either with YAML files or Python packages. YAML files are more simple to create, but are limited to just configuration and template patches.
.. _plugin_config:
config
~~~~~~
@ -222,7 +223,7 @@ You can even define subcommands by creating `command groups <https://click.palle
This would allow any user to see your sub-commands::
$ tutor myplugin
Usage: tutor dev [OPTIONS] COMMAND [ARGS]...
Usage: tutor myplugin [OPTIONS] COMMAND [ARGS]...
I'm a plugin command group