1. Georg Brandl
  2. sphinx

Commits

Georg Brandl  committed 08bd4ea

actually use exception markup

  • Participants
  • Parent commits 90a9f03
  • Branches stable

Comments (0)

Files changed (1)

File doc/extdev/appapi.rst

View file
 
 .. module:: sphinx.errors
 
-.. class:: SphinxError
+.. exception:: SphinxError
 
    This is the base class for "nice" exceptions.  When such an exception is
    raised, Sphinx will abort the build and present the exception category and
       to a string ("category: message").  Should be set accordingly in
       subclasses.
 
-.. class:: ConfigError
+.. exception:: ConfigError
 
    Used for erroneous values or nonsensical combinations of configuration
    values.
 
-.. class:: ExtensionError
+.. exception:: ExtensionError
 
    Used for errors in setting up extensions.
 
-.. class:: ThemeError
+.. exception:: ThemeError
 
    Used for errors to do with themes.
 
-.. class:: VersionRequirementError
+.. exception:: VersionRequirementError
 
    Raised when the docs require a higher Sphinx version than the current one.