Cutlery/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-05-23 17:52:23 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update custom parser docs

Browse Source
This commit is contained in:
shamoon 2025-04-09 16:21:27 -07:00
parent e628c488cf
commit 37f323d836
No known key found for this signature in database
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/development.md
View File

@ -390,7 +390,7 @@ Custom parsers can be added to Paperless-ngx to support more file types. In
order to do that, you need to write the parser itself and announce its order to do that, you need to write the parser itself and announce its
existence to Paperless-ngx. existence to Paperless-ngx.
The parser itself must extend `documents.parsers.DocumentParser` and The parser itself must extend `paperless.parsers.DocumentParser` and
must implement the methods `parse` and `get_thumbnail`. You can provide must implement the methods `parse` and `get_thumbnail`. You can provide
your own implementation to `get_date` if you don't want to rely on your own implementation to `get_date` if you don't want to rely on
Paperless-ngx' default date guessing mechanisms. Paperless-ngx' default date guessing mechanisms.
@ -418,7 +418,7 @@ class MyCustomParser(DocumentParser):
``` ```
If you encounter any issues during parsing, raise a If you encounter any issues during parsing, raise a
`documents.parsers.ParseError`. `paperless.parsers.ParseError`.
The `self.tempdir` directory is a temporary directory that is guaranteed The `self.tempdir` directory is a temporary directory that is guaranteed
to be empty and removed after consumption finished. You can use that to be empty and removed after consumption finished. You can use that