diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs index ebe27088c..54cb86242 100644 --- a/.git-blame-ignore-revs +++ b/.git-blame-ignore-revs @@ -57,10 +57,6 @@ c490ac5810b70f3cf5fd8649669838e8fdb19f4d 769dcdc88a1263638ae25944ba6b2be3e8933666 # Reformat all docs using docstrfmt ab5acaabb3cd24c482adb7fa4800c89fd6a2f08d -# Moved dev docs -2504595532abd7584143007ede087ee4abc00916 -# Moved plugin docs Further Reading chapter -c8cb3813e38fe1381509c39e415c3a5fe0deb808 # Replace format calls with f-strings 4a361bd501e85de12c91c2474c423559ca672852 # Replace percent formatting @@ -71,3 +67,7 @@ c8cb3813e38fe1381509c39e415c3a5fe0deb808 2fccf64efe82851861e195b521b14680b480a42a # Do not use explicit indices for logging args when not needed d93ddf8dd43e4f9ed072a03829e287c78d2570a2 +# Moved dev docs +1f94bdbe4963c693847c24af18b151e12c670995 +# Moved plugin docs Further Reading chapter +18088c654665e84afc0a67173aa8056ca6b57a58 \ No newline at end of file diff --git a/docs/dev/plugins/other.rst b/docs/dev/plugins/other.rst deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/dev/plugins/other/config.rst b/docs/dev/plugins/other/config.rst index 043d4b28a..e5581fe63 100644 --- a/docs/dev/plugins/other/config.rst +++ b/docs/dev/plugins/other/config.rst @@ -1,5 +1,5 @@ Read Configuration Options --------------------------- +========================== Plugins can configure themselves using the ``config.yaml`` file. You can read configuration values in two ways. The first is to use `self.config` within your diff --git a/docs/dev/plugins/other/fields.rst b/docs/dev/plugins/other/fields.rst index 429b726dc..6ee570043 100644 --- a/docs/dev/plugins/other/fields.rst +++ b/docs/dev/plugins/other/fields.rst @@ -1,5 +1,5 @@ Flexible Field Types --------------------- +==================== If your plugin uses flexible fields to store numbers or other non-string values, you can specify the types of those fields. A rating plugin, for example, might diff --git a/docs/dev/plugins/other/import.rst b/docs/dev/plugins/other/import.rst index 77d961522..706a520b7 100644 --- a/docs/dev/plugins/other/import.rst +++ b/docs/dev/plugins/other/import.rst @@ -1,7 +1,7 @@ .. _plugin-stage: Add Import Pipeline Stages --------------------------- +========================== Many plugins need to add high-latency operations to the import workflow. For example, a plugin that fetches lyrics from the Web would, ideally, not block the @@ -44,7 +44,7 @@ adding the function to the plugin's ``early_import_stages`` field instead: .. _extend-query: Extend the Query Syntax -~~~~~~~~~~~~~~~~~~~~~~~ +----------------------- You can add new kinds of queries to beets' :doc:`query syntax `. There are two ways to add custom queries: using a prefix diff --git a/docs/dev/plugins/other/logging.rst b/docs/dev/plugins/other/logging.rst index cae088f50..1c4ce4838 100644 --- a/docs/dev/plugins/other/logging.rst +++ b/docs/dev/plugins/other/logging.rst @@ -1,7 +1,7 @@ .. _plugin-logging: Logging -------- +======= Each plugin object has a ``_log`` attribute, which is a ``Logger`` from the `standard Python logging module`_. The logger is set up to `PEP 3101`_, diff --git a/docs/dev/plugins/other/mediafile.rst b/docs/dev/plugins/other/mediafile.rst index 467fd34ea..8fa22ceca 100644 --- a/docs/dev/plugins/other/mediafile.rst +++ b/docs/dev/plugins/other/mediafile.rst @@ -1,5 +1,5 @@ Extend MediaFile ----------------- +================ MediaFile_ is the file tag abstraction layer that beets uses to make cross-format metadata manipulation simple. Plugins can add fields to MediaFile diff --git a/docs/dev/plugins/other/prompts.rst b/docs/dev/plugins/other/prompts.rst index 8916a3a03..f734f0de3 100644 --- a/docs/dev/plugins/other/prompts.rst +++ b/docs/dev/plugins/other/prompts.rst @@ -1,7 +1,7 @@ .. _append_prompt_choices: Append Prompt Choices ---------------------- +===================== Plugins can also append choices to the prompt presented to the user during an import session. diff --git a/docs/dev/plugins/other/templates.rst b/docs/dev/plugins/other/templates.rst index 21a592603..89509dcb7 100644 --- a/docs/dev/plugins/other/templates.rst +++ b/docs/dev/plugins/other/templates.rst @@ -1,5 +1,5 @@ Add Path Format Functions and Fields ------------------------------------- +==================================== Beets supports *function calls* in its path format syntax (see :doc:`/reference/pathformat`). Beets includes a few built-in functions, but