diff --git a/docs/about/why-waffle.rst b/docs/about/why-waffle.rst index c845d812..77ac596c 100644 --- a/docs/about/why-waffle.rst +++ b/docs/about/why-waffle.rst @@ -19,31 +19,20 @@ Waffle :ref:`aims to ` Waffle has an `active community`_ and gets `fairly steady updates`_. -vs Gargoyle -=========== - -The other major, active feature flag tool for Django is Disqus's -Gargoyle_. Both support similar features, though Gargoyle offers more -options for building custom segments in exchange for some more -complexity and requirements. - - Waffle in Production ==================== -Despite its pre-1.0 version number, Waffle has been used in production -for years at places like Mozilla, Yipit and TodaysMeet. +Waffle has been used in production for years at places like Mozilla, Yipit and TodaysMeet. - Mozilla (Support, MDN, Addons, etc) - TodaysMeet - Yipit (If you're using Waffle in production and don't mind being included -here, let me know or add yourself in a pull request!) +here, let us know or add yourself in a pull request!) .. _Feature flags: http://code.flickr.net/2009/12/02/flipping-out/ .. _several options: https://www.djangopackages.com/grids/g/feature-flip/ .. _active community: https://github.com/jazzband/django-waffle/graphs/contributors .. _fairly steady updates: https://github.com/jazzband/django-waffle/pulse/monthly -.. _Gargoyle: https://github.com/disqus/gargoyle diff --git a/docs/starting/installation.rst b/docs/starting/installation.rst index 5a693592..f97ed371 100644 --- a/docs/starting/installation.rst +++ b/docs/starting/installation.rst @@ -11,13 +11,11 @@ met, installing Waffle is a simple process. Getting Waffle ============== -Waffle is `hosted on PyPI`_ and can be installed with ``pip`` or -``easy_install``: +Waffle is `hosted on PyPI`_ and can be installed with ``pip`` .. code-block:: shell $ pip install django-waffle - $ easy_install django-waffle Waffle is also available `on GitHub`_. In general, ``master`` should be stable, but use caution depending on unreleased versions. @@ -80,33 +78,18 @@ With django-jinja_, add the extension to the ``extensions`` list:: # ... ] -With jingo_, add it to the ``JINJA_CONFIG['extensions']`` list:: - - JINJA_CONFIG = { - 'extensions': [ - # ... - 'waffle.jinja.WaffleExtension', - ], - # ... - } - - .. _installation-settings-migrations: Database Schema =============== Waffle includes `Django migrations`_ for creating the correct database -schema. If using Django >= 1.7, simply run the ``migrate`` management -command after adding Waffle to ``INSTALLED_APPS``: +schema. Simply run the ``migrate`` management command after adding Waffle to +``INSTALLED_APPS``: .. code-block:: shell $ django-admin.py migrate -If you're using a version of Django without migrations, you can run -``syncdb`` to create the Waffle tables. - .. _Django migrations: https://docs.djangoproject.com/en/dev/topics/migrations/ .. _django-jinja: https://pypi.python.org/pypi/django-jinja/ -.. _jingo: http://jingo.readthedocs.org/ diff --git a/docs/testing/automated.rst b/docs/testing/automated.rst index 9da4f532..3d5c0de0 100644 --- a/docs/testing/automated.rst +++ b/docs/testing/automated.rst @@ -53,9 +53,8 @@ Tests that run in a separate process, such as Selenium tests, may not have access to the test database or the ability to mock Waffle values. For tests that make HTTP requests to the system-under-test (e.g. with -Selenium_ or PhantomJS_) the ``WAFFLE_OVERRIDE`` :ref:`setting -` makes it possible to control the value of any -*Flag* via the querystring. +Selenium_) the ``WAFFLE_OVERRIDE`` :ref:`setting ` +makes it possible to control the value of any *Flag* via the querystring. .. highlight:: http @@ -72,4 +71,3 @@ or that it is "off":: .. _mock: http://pypi.python.org/pypi/mock/ .. _fudge: http://farmdev.com/projects/fudge/ .. _Selenium: http://www.seleniumhq.org/ -.. _PhantomJS: http://phantomjs.org/ diff --git a/docs/testing/user.rst b/docs/testing/user.rst index 2069c94c..b8290ec7 100644 --- a/docs/testing/user.rst +++ b/docs/testing/user.rst @@ -159,6 +159,6 @@ Wow, good work! You can use similar methods to derive the impact on other factors. -.. _session variables: https://developers.google.com/analytics/devguides/collection/upgrade/reference/gajs-analyticsjs#custom-vars +.. _session variables: https://support.google.com/analytics/answer/9191807?hl=en .. _#80: https://github.com/jazzband/django-waffle/issues/80 .. _StatsD: https://github.com/etsy/statsd diff --git a/pyproject.toml b/pyproject.toml index 0b67f54d..b9057c32 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -36,6 +36,8 @@ classifiers = [ ] requires-python = ">=3.8" dependencies = ["django>=3.2"] +[project.optional-dependencies] +docs = ["sphinx"] [project.urls] Homepage = "http://github.com/django-waffle/django-waffle"