https://github.com/mkalioby/sphinxcontrib-django-urls

Adds URL Paths to the view function documentation
https://github.com/mkalioby/sphinxcontrib-django-urls

Last synced: over 1 year ago
JSON representation

Adds URL Paths to the view function documentation

• Host: GitHub
• URL: https://github.com/mkalioby/sphinxcontrib-django-urls
• Owner: mkalioby
• License: mit
• Created: 2021-05-26T07:59:17.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-08-24T12:46:13.000Z (almost 4 years ago)
• Last Synced: 2025-03-20T17:09:03.133Z (over 1 year ago)
• Language: Python
• Size: 45.9 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![PyPI version](https://badge.fury.io/py/sphinxcontrib-django-urls.svg)](https://badge.fury.io/py/sphinxcontrib-django-urls)

# sphinxcontrib-django-urls

This project is inspired by [sphinxcontrib-django](https://github.com/edoburu/sphinxcontrib-django), it adds the view's URLs to the view documentation.

![resul_image](img.png)

## Installation

1. `pip install sphinxcontrib-django-urls`

1. add to `extensions` in `conf.py`

   ```python

   extensions = [

   '....' 

   'sphinxcontrib_django_urls',

   '....'

    ]

   ```