Skip to content

Commit

Permalink
Rephrasing Drivers docs for more clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
jgarte committed Mar 7, 2023
1 parent 44019ab commit f29d037
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/drivers/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Drivers
=======

Drivers represents the technical function, which gets configured by the configuration given by a collection.
Drivers represent the tasks which get configured by a collection's configuration.

Each collection must reference a single driver, which cares about:

Expand All @@ -19,16 +19,16 @@ Each collection must reference a single driver, which cares about:

*

Own drivers
Custom drivers
-----------

You can specify own drivers directly inside your ``conf.py`` file.
You can create your own drivers directly inside your ``conf.py`` file.

Using own drivers instead of e.g. a pure function call has several advantages:
Creating your own drivers has several advantages:

* Configuration handling.
* Correct and easy logging.
* Executed during correct Sphinx phases.
* Ensure execution during correct Sphinx phases.
* Integrated clean-up.
* Report capabilities.

Expand All @@ -55,7 +55,7 @@ Using own drivers instead of e.g. a pure function call has several advantages:
},
}
If you have created an awesome driver, please consider to provide it to ``Sphinx-Collections`` by creating
If you have created an awesome driver, please consider contributing it to ``Sphinx-Collections`` by creating
a PR on our `github project <https://github.com/useblocks/sphinx-collections>`_ .
This would help our little Sphinx community a lot. Thanks!

Expand Down

0 comments on commit f29d037

Please sign in to comment.