Metadata-Version: 2.4
Name: django-userguide
Version: 0.1.9
Summary: Django-userguide library
Author-email: Altcomp <it@altcomp.pl>
License-Expression: MIT
Classifier: Framework :: Django
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: Django>=4.2
Requires-Dist: djangorestframework>=3.15
Requires-Dist: django-filter>=25.1
Requires-Dist: djangorestframework-camel-case>=1.4.2

# django-userguide

### Installation

```python
INSTALLED_APPS = [
    'userguide',
]

#
# Markdown editor in Django Admin Site
#

X_FRAME_OPTIONS = "SAMEORIGIN"

MDEDITOR_CONFIGS = {
    'default': {
        'language': 'en',
    }
}
```

### Application settings

```python
# Example settings

# Default size of the truncated string length to use in some serializers.
# Please be aware that, if the string exceeds max length, an extra '...' will be concatenated.
USER_GUIDE_STRING_TRUNCATE_LENGTH = 25

# Permission classes to use in view sets.
# It's not required (Default to []).
# Permission classes must be a list of strings to be imported dynamically in BaseViewSet.
USER_GUIDE_PERMISSION_CLASSES = []

# Authentication classes to use in view sets.
# It's not required (Default to []).
# Authentication classes must be a list of strings to be imported dynamically in BaseViewSet.
USER_GUIDE_AUTHENTICATION_CLASSES = []
```
