diff options
| author | Ilya Etingof <etingof@gmail.com> | 2019-07-13 11:09:28 +0200 |
|---|---|---|
| committer | Ilya Etingof <etingof@gmail.com> | 2019-07-13 11:09:28 +0200 |
| commit | e1500c60c0a15a641d5ee834f792fd0f2167c8b8 (patch) | |
| tree | 3b0330806b1b86f9d17ca0306f04b3e358bda68d /docs | |
| parent | 4b24fcb98a21a6259ab1b71cd46f382401fad508 (diff) | |
| download | pyasn1-git-e1500c60c0a15a641d5ee834f792fd0f2167c8b8.tar.gz | |
Add exception classes documentation
Also fix references to exception objects in other docstrings.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/pyasn1/contents.rst | 13 | ||||
| -rw-r--r-- | docs/source/pyasn1/error/contents.rst | 60 |
2 files changed, 73 insertions, 0 deletions
diff --git a/docs/source/pyasn1/contents.rst b/docs/source/pyasn1/contents.rst index 474bbff..554ebe9 100644 --- a/docs/source/pyasn1/contents.rst +++ b/docs/source/pyasn1/contents.rst @@ -212,3 +212,16 @@ implemented in pyasn1. /pyasn1/codec/cer/contents /pyasn1/codec/der/contents /pyasn1/codec/native/contents + +Exceptions +---------- + +Operations on PyASN1 schema and value objects might cause errors. These +errors are manifested to the caller in form of Python exceptions. + +The exception hierarchy is as follows (ordered from least specific). + +.. toctree:: + :maxdepth: 2 + + /pyasn1/error/contents diff --git a/docs/source/pyasn1/error/contents.rst b/docs/source/pyasn1/error/contents.rst new file mode 100644 index 0000000..be8a04c --- /dev/null +++ b/docs/source/pyasn1/error/contents.rst @@ -0,0 +1,60 @@ + +.. _error.PyAsn1Error: + +.. |PyAsn1Error| replace:: PyAsn1Error + +|PyAsn1Error| +------------- + +.. autoclass:: pyasn1.error.PyAsn1Error + :members: + +.. _error.ValueConstraintError: + +.. |ValueConstraintError| replace:: ValueConstraintError + +|ValueConstraintError| +---------------------- + +.. autoclass:: pyasn1.error.ValueConstraintError + :members: + +.. _error.SubstrateUnderrunError: + +.. |SubstrateUnderrunError| replace:: SubstrateUnderrunError + +|SubstrateUnderrunError| +------------------------ + +.. autoclass:: pyasn1.error.SubstrateUnderrunError + :members: + +.. _error.PyAsn1UnicodeError: + +.. |PyAsn1UnicodeError| replace:: PyAsn1UnicodeError + +|PyAsn1UnicodeError| +-------------------- + +.. autoclass:: pyasn1.error.PyAsn1UnicodeError + :members: + +.. _error.PyAsn1UnicodeDecodeError: + +.. |PyAsn1UnicodeDecodeError| replace:: PyAsn1UnicodeDecodeError + +|PyAsn1UnicodeDecodeError| +-------------------------- + +.. autoclass:: pyasn1.error.PyAsn1UnicodeDecodeError + :members: + +.. _error.PyAsn1UnicodeEncodeError: + +.. |PyAsn1UnicodeEncodeError| replace:: PyAsn1UnicodeEncodeError + +|PyAsn1UnicodeEncodeError| +-------------------------- + +.. autoclass:: pyasn1.error.PyAsn1UnicodeEncodeError + :members: |