Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions MANIFEST.in

This file was deleted.

24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/codingjoe/django-select2/raw/main/images/logo-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="https://github.com/codingjoe/django-select2/raw/main/images/logo-light.svg">
<img alt="Django Select2: Custom autocomplete fields for Django" src="https://github.com/codingjoe/django-select2/raw/main/images/logo-light.svg">
</picture>
<br>
<a href="https://django-select2.rtfd.io">Documentation</a>
</p>

# Django-Select2

[![version](https://img.shields.io/pypi/v/Django-Select2.svg)](https://pypi.python.org/pypi/Django-Select2/)
[![coverage](https://codecov.io/gh/codingjoe/django-select2/branch/main/graph/badge.svg)](https://codecov.io/gh/codingjoe/django-select2)
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/codingjoe/django-select2/main/LICENSE.txt)

Custom autocomplete fields for [Django](https://www.djangoproject.com/).

## Documentation

Documentation available at <https://django-select2.rtfd.io>.

> [!NOTE]
> Django's admin comes with builtin support for Select2 via the [autocomplete_fields](https://docs.djangoproject.com/en/stable/ref/contrib/admin/#django.contrib.admin.ModelAdmin.autocomplete_fields) feature.
31 changes: 0 additions & 31 deletions README.rst

This file was deleted.

7 changes: 0 additions & 7 deletions SECURITY.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
version = ".".join(release.split(".")[:2])

master_doc = "index" # default in Sphinx v2
html_theme = "furo"


extensions = [
Expand Down
11 changes: 10 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
.. include:: ../README.rst
Django Select2
==============

.. image:: https://github.com/codingjoe/django-select2/raw/main/images/logo-light.svg
:align: center
:class: only-light

.. image:: https://github.com/codingjoe/django-select2/raw/main/images/logo-dark.svg
:align: center
:class: only-dark

Installation
------------
Expand Down
13 changes: 13 additions & 0 deletions images/logo-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions images/logo-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 0 additions & 5 deletions linter-requirements.txt

This file was deleted.

3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ name = "django-select2"
authors = [
{ name = "Johannes Maron", email = "johannes@maron.family" },
]
readme = "README.rst"
readme = "README.md"
license = { file = "LICENSE" }
keywords = ["Django", "select2", "autocomplete", "typeahead"]
dynamic = ["version", "description"]
Expand Down Expand Up @@ -48,6 +48,7 @@ test = [
]
docs = [
"sphinx",
"furo",
]

[project.urls]
Expand Down
4 changes: 0 additions & 4 deletions setup.cfg

This file was deleted.

Loading