SITE_BY_REQUEST missing from docs

[thenewguy]

Used in the following places:

• django-robots/src/robots/settings.py

  Line 11 in be2e781

  "SITE_BY_REQUEST": ("ROBOTS_SITE_BY_REQUEST", False),

• django-robots/src/robots/views.py

  Line 22 in be2e781

  if settings.SITE_BY_REQUEST:

[some1ataplace]

SITE_BY_REQUEST is a setting in django-robots that determines whether the robots.txt file should be generated dynamically based on the current request's domain.

When SITE_BY_REQUEST is set to True, the get_robots_txt() function in django_robots/utils.py will generate the robots.txt file based on the domain of the current request. This can be useful if you have multiple sites running on the same Django instance, each with their own robots.txt file.

To use SITE_BY_REQUEST, you can set the ROBOTS_SITE_BY_REQUEST setting in your Django settings file to True:

ROBOTS_SITE_BY_REQUEST = True

Then, in your RobotsView class in django_robots/views.py, you can check the value of settings.SITE_BY_REQUEST to determine whether to generate the robots.txt file dynamically:

from django.views.generic import TemplateView
from django_robots.utils import get_robots_txt
from django.conf import settings

class RobotsView(TemplateView):
    content_type = 'text/plain'

    def render_to_response(self, context, **kwargs):
        if settings.SITE_BY_REQUEST:
            content = get_robots_txt(request=self.request)
        else:
            content = get_robots_txt()
        response = self.get_response(content)
        return response

In this modified implementation, we're checking the value of settings.SITE_BY_REQUEST to determine whether to generate the robots.txt file dynamically using the get_robots_txt() function with the request parameter set to self.request. If SITE_BY_REQUEST is False, we generate the robots.txt file using the default behavior of get_robots_txt().

By default, SITE_BY_REQUEST is set to False, so if you don't need to generate the robots.txt file dynamically, you don't need to do anything. However, if you have multiple sites running on the same Django instance and each site has its own robots.txt file, you can use SITE_BY_REQUEST to generate the correct robots.txt file for each site based on the current request's domain.