summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMathieu Pillard <mpillard@mozilla.com>2021-12-12 19:04:27 +0100
committerMathieu Pillard <mpillard@mozilla.com>2021-12-12 19:04:27 +0100
commitc0287d1dd61cee2c792c130552729d499a446c24 (patch)
treee0cf9b8ccd5185ab72987b21a1cf392f765ff8f9 /docs
parent6ac42adeba9922fd1ebf80aa37c21390cbb4854b (diff)
parent101cc45b4a2af45fea418be8f636bc6d0b22ada9 (diff)
downloaddjango-compressor-c0287d1dd61cee2c792c130552729d499a446c24.tar.gz
Merge branch 'develop'
Diffstat (limited to 'docs')
-rw-r--r--docs/changelog.txt27
-rw-r--r--docs/conf.py14
-rw-r--r--docs/contributing.txt24
-rw-r--r--docs/quickstart.txt1
-rw-r--r--docs/reactjs.txt2
-rw-r--r--docs/remote-storages.txt4
-rw-r--r--docs/settings.txt14
7 files changed, 42 insertions, 44 deletions
diff --git a/docs/changelog.txt b/docs/changelog.txt
index c529e6f..016b00d 100644
--- a/docs/changelog.txt
+++ b/docs/changelog.txt
@@ -1,7 +1,32 @@
Changelog
=========
-v2.4 (2019-12-02)
+v3.0 (2021-??-??)
+
+`Full Changelog <https://github.com/django-compressor/django-compressor/compare/2.4.1...3.0>`_
+
+- Officially support for Python 3.9 and 3.10 as well as Django 3.1, 3.2 and 4.0
+- Drop support for Django 1.11 and 2.1
+- Drop support for Python 2.x and 3.4
+- Fix compatibility with Jinja 3.x
+- Require django-sekizai 2.0 for django-sekizai extension
+- Make template compression in compress command threaded to improve performance
+- Correctly handle relative paths in ``extends`` tags (#979)
+- Enable ``rCSSMinFilter`` by default (#888)
+- Fix various deprecation warnings
+- Add ability to pass a logger to various classes & methods
+- Removed deprecated ``COMPRESS_JS_FILTERS`` and ``COMPRESS_CSS_FILTERS`` settings
+- Fix offline compression race condition, which could result in incomplete manifest
+
+v2.4.1 (2021-04-17)
+-----------------
+
+`Full Changelog <https://github.com/django-compressor/django-compressor/compare/2.4...2.4.1>`_
+
+- Raise proper ``DeprecationWarning`` for ``COMPRESS_JS_FILTERS`` and ``COMPRESS_CSS_FILTERS``
+
+
+v2.4 (2019-12-31)
-----------------
`Full Changelog <https://github.com/django-compressor/django-compressor/compare/2.3...2.4>`_
diff --git a/docs/conf.py b/docs/conf.py
index 34552c3..26d9436 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-#
# django-compressor documentation build configuration file, created by
# sphinx-quickstart on Fri Jan 21 11:47:42 2011.
#
@@ -41,8 +39,8 @@ source_suffix = '.txt'
master_doc = 'index'
# General information about the project.
-project = u'Django Compressor'
-copyright = u'2014, Django Compressor authors'
+project = 'Django Compressor'
+copyright = '2014, Django Compressor authors'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -184,8 +182,8 @@ htmlhelp_basename = 'django-compressordoc'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
- ('index', 'django-compressor.tex', u'Django Compressor Documentation',
- u'Django Compressor authors', 'manual'),
+ ('index', 'django-compressor.tex', 'Django Compressor Documentation',
+ 'Django Compressor authors', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
@@ -217,6 +215,6 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- ('index', 'django-compressor', u'Django Compressor Documentation',
- [u'Django Compressor authors'], 1)
+ ('index', 'django-compressor', 'Django Compressor Documentation',
+ ['Django Compressor authors'], 1)
]
diff --git a/docs/contributing.txt b/docs/contributing.txt
index ffdcbc7..1fee501 100644
--- a/docs/contributing.txt
+++ b/docs/contributing.txt
@@ -9,11 +9,7 @@ tidy, everybody has to follow a few rules (nothing major, I promise :) )
Community
---------
-People interested in developing for the Django Compressor should:
-
-#. Head over to #django-compressor on the `freenode`_ IRC network for help and to
- discuss the development.
-#. Open an issue on GitHub explaining your ideas.
+People interested in developing for the Django Compressor should open an issue on GitHub explaining your ideas.
In a nutshell
@@ -36,8 +32,8 @@ Getting the source code
^^^^^^^^^^^^^^^^^^^^^^^
If you're interested in developing a new feature for Compressor, it is
-recommended that you first discuss it on IRC not to do any work that will
-not get merged in anyway.
+recommended that you first discuss it in an issue in order not to do any
+work that wouldn't get merged anyway.
- Code will be reviewed and tested by at least one core developer, preferably
by several. Other community members are welcome to give feedback.
@@ -100,17 +96,14 @@ Generally tests should be:
In a similar way to code, pull requests will be reviewed before pulling
(obviously), and we encourage discussion via code review (everybody learns
-something this way) or IRC discussions.
+something this way).
Running the tests
^^^^^^^^^^^^^^^^^
To run the tests simply fork django_compressor, make the changes and open
-a pull request. The Travis_ bot will automatically run the tests of your
-branch/fork (see the `pull request announcment`_ for more info) and add a
-comment about the test results to the pull requests. Alternatively you
-can also login at Travis and enable your fork to run there, too. See the
-`Travis documentation`_ to read about how to do that.
+a pull request. The Github actions will automatically run the tests of your
+branch/fork and add a status about the test results to the pull requests.
Alternatively, create a virtualenv and activate it, then install the
requirements **in the virtualenv**::
@@ -160,15 +153,10 @@ double cookie points. Seriously. You rock.
`django CMS`_ project. Many thanks for allowing us to steal it!
.. _Fork: http://github.com/django-compressor/django-compressor
-.. _Travis: http://travis-ci.org/
-.. _`pull request announcment`: http://about.travis-ci.org/blog/announcing-pull-request-support/
-.. _`Travis documentation`: http://about.travis-ci.org/docs/
.. _Sphinx: http://sphinx.pocoo.org/
.. _PEP8: http://www.python.org/dev/peps/pep-0008/
.. _github : http://www.github.com
.. _github help : http://help.github.com
-.. _freenode : http://freenode.net/
-.. _@jezdez : https://twitter.com/jezdez
.. _pull request : http://help.github.com/send-pull-requests/
.. _git : http://git-scm.com/
.. _restructuredText: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
diff --git a/docs/quickstart.txt b/docs/quickstart.txt
index 7ecbd51..86d09c2 100644
--- a/docs/quickstart.txt
+++ b/docs/quickstart.txt
@@ -99,4 +99,5 @@ Optional Dependencies
.. _`Calmjs`: https://github.com/calmjs/calmjs.parse
.. _django-appconf: http://pypi.python.org/pypi/django-appconf/
.. _versiontools: http://pypi.python.org/pypi/versiontools/
+.. _csscompressor: https://pypi.org/project/csscompressor/
.. _brotli: https://pypi.python.org/pypi/brotli
diff --git a/docs/reactjs.txt b/docs/reactjs.txt
index c1dfc8b..269d633 100644
--- a/docs/reactjs.txt
+++ b/docs/reactjs.txt
@@ -48,7 +48,7 @@ Installation
def __init__(self, content, *args, **kwargs):
self.content = content
kwargs.pop('filter_type')
- super(ReactFilter, self).__init__(content, *args, **kwargs)
+ super().__init__(content, *args, **kwargs)
def input(self, **kwargs):
return jsx.transform_string(self.content)
diff --git a/docs/remote-storages.txt b/docs/remote-storages.txt
index 2b14ab9..8342bd3 100644
--- a/docs/remote-storages.txt
+++ b/docs/remote-storages.txt
@@ -61,13 +61,13 @@ apps can be integrated.
S3 storage backend that saves the files locally, too.
"""
def __init__(self, *args, **kwargs):
- super(CachedS3Boto3Storage, self).__init__(*args, **kwargs)
+ super().__init__(*args, **kwargs)
self.local_storage = get_storage_class(
"compressor.storage.CompressorFileStorage")()
def save(self, name, content):
self.local_storage._save(name, content)
- super(CachedS3Boto3Storage, self).save(name, self.local_storage._open(name))
+ super().save(name, self.local_storage._open(name))
return name
#. Set your :attr:`~django.conf.settings.COMPRESS_STORAGE` and STATICFILES_STORAGE_
diff --git a/docs/settings.txt b/docs/settings.txt
index b2df54c..456547c 100644
--- a/docs/settings.txt
+++ b/docs/settings.txt
@@ -267,20 +267,6 @@ Backend settings
.. _`Slim It`: https://github.com/rspivak/slimit
.. _`Calmjs`: https://github.com/calmjs/calmjs.parse
-.. attribute:: COMPRESS_CSS_FILTERS
-
- Backwards-compatible alias for the ``'css'`` key of
- :attr:`~django.conf.settings.COMPRESS_FILTERS`.
- If you haven't defined that key you can still continue
- using this setting, although we encourage you to convert it to the new form.
-
-.. attribute:: COMPRESS_JS_FILTERS
-
- Backwards-compatible alias for the ``'js'`` key of
- :attr:`~django.conf.settings.COMPRESS_FILTERS`.
- If you haven't defined that key you can still continue
- using this setting, although we encourage you to convert it to the new form.
-
.. attribute:: COMPRESS_PRECOMPILERS
:Default: ``()``