-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5043 from dojutsu-user/docs-for-feature-flags
Docs for feature flag
- Loading branch information
Showing
4 changed files
with
63 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
[rstcheck] | ||
ignore_directives=automodule,http:get,tabs,tab,prompt | ||
ignore_roles=djangosetting,setting | ||
ignore_roles=djangosetting,setting,featureflags | ||
ignore_messages=(Duplicate implicit target name: ".*")|(Hyperlink target ".*" is not referenced) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
Feature Flags | ||
============= | ||
|
||
Read the Docs offers some additional flag settings which can be only be configured by the site admin. | ||
These are optional settings and you might not need it for every project. | ||
By default, these flags are disabled for every project. | ||
A seperate request can be made by opening an issue on our `github`_ to enable | ||
or disable one or more of these featured flags for a particular project. | ||
|
||
.. _github: https://github.com/rtfd/readthedocs.org | ||
|
||
Available Flags | ||
--------------- | ||
|
||
``USE_SPHINX_LATEST``: :featureflags:`USE_SPHINX_LATEST` | ||
|
||
``USE_SETUPTOOLS_LATEST``: :featureflags:`USE_SETUPTOOLS_LATEST` | ||
|
||
``ALLOW_DEPRECATED_WEBHOOKS``: :featureflags:`ALLOW_DEPRECATED_WEBHOOKS` | ||
|
||
``PIP_ALWAYS_UPGRADE``: :featureflags:`PIP_ALWAYS_UPGRADE` | ||
|
||
``SKIP_SUBMODULES``: :featureflags:`SKIP_SUBMODULES` | ||
|
||
``DONT_OVERWRITE_SPHINX_CONTEXT``: :featureflags:`DONT_OVERWRITE_SPHINX_CONTEXT` | ||
|
||
``ALLOW_V2_CONFIG_FILE``: :featureflags:`ALLOW_V2_CONFIG_FILE` | ||
|
||
``MKDOCS_THEME_RTD``: :featureflags:`MKDOCS_THEME_RTD` | ||
|
||
``DONT_SHALLOW_CLONE``: :featureflags:`DONT_SHALLOW_CLONE` |