implement rst role

Author: dojutsu-user

docs/.rstcheck.cfg

@@ -1,4 +1,4 @@
 [rstcheck]
 ignore_directives=automodule,http:get,tabs,tab
-ignore_roles=djangosetting,setting
+ignore_roles=djangosetting,setting,featureflags
 ignore_messages=(Duplicate implicit target name: ".*")|(Hyperlink target ".*" is not referenced)

docs/doc_extensions.py

@@ -12,6 +12,8 @@
 
 from django.conf import settings
 
+from readthedocs.projects.models import Feature
+
 
 def django_setting_role(typ, rawtext, text, lineno, inliner, options=None,
                         content=None):
@@ -21,9 +23,31 @@ def django_setting_role(typ, rawtext, text, lineno, inliner, options=None,
     return [node], []
 
 
+def feature_flags_role(typ, rawtext, text, lineno, inliner, options=None,
+                        content=None):
+    """Up to date feature flags from the application."""
+    features_dict = {}
+    for feature in Feature.FEATURES:
+        features_dict[feature[0].upper()] = feature[1].capitalize()
+    dl = nodes.definition_list()
+    for feature, desc in features_dict.items():
+        term = nodes.term(text=feature)
+        definition = nodes.definition(text=desc)
+        dli = nodes.definition_list_item(term=term, definition=definition)
+        dl.append(dli)
+    return [dl], []
+
+
 def setup(_):
     from docutils.parsers.rst import roles
-    roles.register_local_role('djangosetting', django_setting_role)
+    roles.register_local_role(
+        'djangosetting',
+        django_setting_role
+    )
+    roles.register_local_role(
+        'featureflags',
+        feature_flags_role
+    )
 
     return {
         'version': 'builtin',

docs/faq.rst

@@ -65,11 +65,12 @@ environment, and will be set to ``True`` when building on RTD::
     {% endif %}
 
 My project requires different settings than those available under Admin
---------------------------------------------------------------------------
+-----------------------------------------------------------------------
 
-Read the Docs offers additional flag settings. To enable these settings,
+Read the Docs offers some settings which can be used for a variety of purposes,
+such as to use the latest version of sphinx or pip. To enable these settings,
 please open a request issue on our `github`_ and we will change the settings for the project.
-Read more about these flag settings :doc:`here <guides/feature-flags>`.
+Read more about these settings :doc:`here <guides/feature-flags>`.
 
 .. _github: https://github.com/rtfd/readthedocs.org
 

docs/guides/feature-flags.rst

@@ -12,48 +12,4 @@ or disable one or more of these featured flags for a particular project.
 Available Flags
 ---------------
 
-USE_SPHINX_LATEST:
-~~~~~~~~~~~~~~~~~~
-
-Use latest version of Sphinx in building the project.
-
-USE_SETUPTOOLS_LATEST:
-~~~~~~~~~~~~~~~~~~~~~~
-
-Use latest version of setuptools in building the project.
-
-ALLOW_DEPRECATED_WEBHOOKS:
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Allow deprecated webhook views.
-
-PIP_ALWAYS_UPGRADE:
-~~~~~~~~~~~~~~~~~~~
-
-Always run:
-
-.. code-block:: bash
-
-    pip install --upgrade
-
-before building the project.
-
-SKIP_SUBMODULES:
-~~~~~~~~~~~~~~~~
-
-Skip git submodule checkout.
-
-DONT_OVERWRITE_SPHINX_CONTEXT:
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Do not overwrite context vars in conf.py with Read the Docs context.
-
-ALLOW_V2_CONFIG_FILE:
-~~~~~~~~~~~~~~~~~~~~~
-
-Allow to use the v2 of the configuration file.
-
-MKDOCS_THEME_RTD:
-~~~~~~~~~~~~~~~~~
-
-Use Read the Docs theme for MkDocs as default theme.
+:featureflags: