readthedocs.org/docs/settings.rst

49 lines
1.3 KiB
ReStructuredText
Raw Normal View History

Interesting Settings
====================
USE_SUBDOMAINS
---------------
Default: `False`
Whether to use subdomains in URLs on the site, or the Django-served content.
When used in production, this should be True, as Nginx will serve this content.
During developemnt and other possible deployments, this might be False.
PRODUCTION_DOMAIN
2012-10-28 06:29:50 +00:00
------------------
Default: `readthedocs.org`
This is the domain that gets linked to throughout the site when used in production.
2012-09-26 01:06:55 +00:00
It depends on `USE_SUBDOMAINS`, otherwise it isn't used.
VARNISH_SERVERS
2012-02-11 03:00:07 +00:00
----------------
Default: `undefined`
This is a list of the varnish servers that you are using. It is used to perform cache invalidation. If this settings is not defined, no invalidation will be done.
MULTIPLE_APP_SERVERS
--------------------
Default: `undefined`
This is a list of application servers that built documentation is copied to. This allows you to run an independent build server, and then have it rsync your built documentation across multiple front end documentation/app servers.
2012-10-21 07:40:16 +00:00
SLUMBER_USERNAME
----------------
Default: `test`
The username to use when connecting to the Read the Docs API. Used for hitting the API while building the docs.
SLUMBER_PASSWORD
----------------
Default: `test`
The password to use when connecting to the Read the Docs API. Used for hitting the API while building the docs.