amorfo77/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2026-06-20 20:34:20 +00:00
Code Issues Projects Releases Wiki Activity

Documentation (beta): Updates documentation for new v3 features (#13033)

Browse Source 
Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>
This commit is contained in:
Trenton H
2026-06-18 16:20:31 -07:00
committed by GitHub
parent a009ea1f04
commit bb5d7438b1
10 changed files with 187 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/development.md
+9 -8
View File
@@ -132,7 +132,7 @@ uv run manage.py runserver & \
```
You might need the front end to test your back end code.
This assumes that you have AngularJS installed on your system.
This assumes that you have Angular installed on your system.
Go to the [Front end development](#front-end-development) section for further details.
To build the front end once use this command:
@@ -174,7 +174,7 @@ To add a new development package `uv add --dev <package>`
## Front end development
The front end is built using AngularJS. In order to get started, you need Node.js (version 24+) and
The front end is built using Angular. In order to get started, you need Node.js (version 24+) and
`pnpm`.
!!! note
@@ -248,12 +248,12 @@ that authentication is working.
## Localization
Paperless-ngx is available in many different languages. Since Paperless-ngx
consists both of a Django application and an AngularJS front end, both
consists both of a Django application and an Angular front end, both
these parts have to be translated separately.
### Front end localization
- The AngularJS front end does localization according to the [Angular
- The Angular front end does localization according to the [Angular
documentation](https://angular.io/guide/i18n).
- The source language of the project is "en_US".
- The source strings end up in the file `src-ui/messages.xlf`.
@@ -495,7 +495,7 @@ class MyCustomParser:
self._tempdir = Path(
tempfile.mkdtemp(prefix="paperless-", dir=settings.SCRATCH_DIR)
)
self._text: str | None = None
self._text: str = ""
self._archive_path: Path | None = None
def __enter__(self) -> Self:
@@ -553,7 +553,8 @@ def parse(
**Result accessors**
```python
def get_text(self) -> str | None:
def get_text(self) -> str:
# Return the extracted text, or an empty string if none was found.
return self._text
def get_date(self) -> "datetime.datetime | None":
@@ -684,7 +685,7 @@ class XmlDocumentParser:
def __init__(self, logging_group: object = None) -> None:
settings.SCRATCH_DIR.mkdir(parents=True, exist_ok=True)
self._tempdir = Path(tempfile.mkdtemp(prefix="paperless-", dir=settings.SCRATCH_DIR))
self._text: str | None = None
self._text: str = ""
def __enter__(self) -> Self:
return self
@@ -702,7 +703,7 @@ class XmlDocumentParser:
except ET.ParseError as e:
raise ParseError(f"XML parse error: {e}") from e
def get_text(self) -> str | None:
def get_text(self) -> str:
return self._text
def get_date(self):