centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

Move more documentation from Markdown into docstrings

Browse Source
This commit is contained in:
Oleh Prypin
2022-09-18 16:35:33 +02:00
parent 5685e93406
commit 00a71ba0be
2 changed files with 14 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/dev-guide/plugins.md
View File

@@ -319,34 +319,19 @@ For each event type, corresponding methods of plugins are called in the order th
Since MkDocs 1.4, plugins can choose to set a priority value for their events. Events with higher priority are called first. Events without a chosen priority get a default of 0. Events that have the same priority are ordered as they appear in the config. Since MkDocs 1.4, plugins can choose to set a priority value for their events. Events with higher priority are called first. Events without a chosen priority get a default of 0. Events that have the same priority are ordered as they appear in the config.
::: mkdocs.plugins.event_priority #### ::: mkdocs.plugins.event_priority
options:
show_root_heading: true
### Handling Errors ### Handling Errors
MkDocs defines four error types: MkDocs defines four error types:
#### `mkdocs.exceptions.MkDocsException` #### ::: mkdocs.exceptions.MkDocsException
* The base class which all MkDocs exceptions inherit from. This should #### ::: mkdocs.exceptions.ConfigurationError
not be raised directly. One of the subclasses should be raised instead.
#### `mkdocs.exceptions.ConfigurationError` #### ::: mkdocs.exceptions.BuildError
* This error is raised by configuration validation when a validation error #### ::: mkdocs.exceptions.PluginError
is encountered. This error should be raised by any configuration options
defined in a plugin's [config_scheme].
#### `mkdocs.exceptions.BuildError`
* This error may be raised by MkDocs during the build process. Plugins should
not raise this error.
#### `mkdocs.exceptions.PluginError`
* A subclass of `mkdocs.exceptions.BuildError` which can be raised by plugin
events.
Unexpected and uncaught exceptions will interrupt the build process and produce Unexpected and uncaught exceptions will interrupt the build process and produce
typical Python tracebacks, which are useful for debugging your code. However, typical Python tracebacks, which are useful for debugging your code. However,
@@ -428,4 +413,3 @@ tell MkDocs to use it via the config.
[Template Events]: #template-events [Template Events]: #template-events
[MkDocs Plugins]: https://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins [MkDocs Plugins]: https://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins
[on_build_error]: #on_build_error [on_build_error]: #on_build_error
[config_scheme]: #config_scheme

13
mkdocs/exceptions.py
View File

@@ -4,7 +4,8 @@ from click import ClickException, echo
class MkDocsException(ClickException): class MkDocsException(ClickException):
"""Base exceptions for all MkDocs Exceptions""" """The base class which all MkDocs exceptions inherit from. This should
not be raised directly. One of the subclasses should be raised instead."""
class Abort(MkDocsException): class Abort(MkDocsException):
@@ -15,12 +16,16 @@ class Abort(MkDocsException):
class ConfigurationError(MkDocsException): class ConfigurationError(MkDocsException):
"""Error in configuration""" """This error is raised by configuration validation when a validation error
is encountered. This error should be raised by any configuration options
defined in a plugin's [config_scheme][]."""
class BuildError(MkDocsException): class BuildError(MkDocsException):
"""Error during the build process""" """This error may be raised by MkDocs during the build process. Plugins should
not raise this error."""
class PluginError(BuildError): class PluginError(BuildError):
"""Error in a plugin""" """A subclass of [`mkdocs.exceptions.BuildError`][] which can be raised by plugin
events."""