Metadata-Version: 2.4
Name: sphinxcontrib-drf
Version: 0.2.0
Summary: 
Author: Bulat Kurbanov
Author-email: kurbanovbul@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: django (>=5.0,<6.0)
Requires-Dist: djangorestframework (>=3.15.1,<4.0.0)
Requires-Dist: sphinx (>=6.1.3,<7.0.0)
Description-Content-Type: text/markdown

# sphinxcontrib-drf


## Installation

Install the package via pip:

```
pip install sphinxcontrib-django  # base setup and models docs
pip install sphinxcontrib-drf
```

## Configuration

Add the following to your Sphinx config file ``conf.py``:

```

# Add source directory to sys.path
sys.path.insert(0, os.path.abspath("../src"))

# Add sphinxcontrib_django to installed extensions
extensions = [
    "sphinxcontrib_django",
    "sphinxcontrib-drf"
]

django_settings = "myapp.settings"
```

