设置

USE_SUBDOMAIN

默认: 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

默认: readthedocs.org

This is the domain that gets linked to throughout the site when used in production. It depends on USE_SUBDOMAIN, otherwise it isn’t used.

VARNISH_SERVERS

默认: 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

默认: 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.

SLUMBER_USERNAME

默认: test

The username to use when connecting to the Read the Docs API. Used for hitting the API while building the docs.

SLUMBER_PASSWORD

默认: test

The password to use when connecting to the Read the Docs API. Used for hitting the API while building the docs.

INDEX_ONLY_LATEST

默认: False

In search, only index the latest version of a Project.

DOCUMENT_PYQUERY_PATH

默认: div.document

The Pyquery path to an HTML element that is the root of your document. This is used for making sure we are only searching the main content of a document.

USE_PIP_INSTALL

默认: False

Whether to use pip install . or python setup.py install when installing packages into the Virtualenv. 默认 is to use pip.

Read the Docs v: latest
Versions
latest
Downloads
PDF
HTML
Epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.