diff options
| author | Paul Ganssle <paul@ganssle.io> | 2020-01-02 11:31:58 -0500 |
|---|---|---|
| committer | Paul Ganssle <paul@ganssle.io> | 2020-01-02 14:49:54 -0500 |
| commit | 5197a8854b86945dd899cdbab86dd7e70f96aee9 (patch) | |
| tree | da927b999e87b20da560172c8326f250c8f7d7d9 | |
| parent | 579cd769f05a75855be37b32c13910cc04e3f86f (diff) | |
| download | dateutil-git-5197a8854b86945dd899cdbab86dd7e70f96aee9.tar.gz | |
Rearrange parser documentation
Previously the parser documentation did not include warnings and
exceptions. This rearranges things to cleanly separate out functions,
classes and exceptions / warnings, and adds the warnings to the
documentation.
| -rw-r--r-- | changelog.d/992.doc.rst | 2 | ||||
| -rw-r--r-- | docs/parser.rst | 27 |
2 files changed, 24 insertions, 5 deletions
diff --git a/changelog.d/992.doc.rst b/changelog.d/992.doc.rst new file mode 100644 index 0000000..60e29e1 --- /dev/null +++ b/changelog.d/992.doc.rst @@ -0,0 +1,2 @@ +Rearranged parser documentation into "Functions", "Classes" and "Warnings and +Exceptions" categories. (gh issue #992, pr #994). diff --git a/docs/parser.rst b/docs/parser.rst index 02ce74e..1f1564e 100644 --- a/docs/parser.rst +++ b/docs/parser.rst @@ -1,12 +1,29 @@ ====== parser ====== + .. automodule:: dateutil.parser - .. automethod:: dateutil.parser.parse +Functions +--------- + +.. automethod:: dateutil.parser.parse + +.. automethod:: dateutil.parser.isoparse + + +Classes +------- + +.. autoclass:: dateutil.parser.parserinfo + :members: + :undoc-members: + + +Warnings and Exceptions +----------------------- + +.. autoclass:: dateutil.parser.ParserError - .. autoclass:: dateutil.parser.parserinfo - :members: - :undoc-members: +.. autoclass:: dateutil.parser.UnknownTimezoneWarning - .. automethod:: dateutil.parser.isoparse |