envoyproxy/envoy

Extension matcher documentation doesn't generate a link to the xds Matcher type

Open

#18 154 ouverte le 17 sept. 2021

Voir sur GitHub
 (5 commentaires) (0 réactions) (1 assigné)C++ (5 373 forks)batch import
area/docsbughelp wantedno stalebot

Métriques du dépôt

Stars
 (27 997 stars)
Métriques de merge PR
 (Merge moyen 8j) (378 PRs mergées en 30 j)

Description

Title: Extension matcher documentation doesn't generate a link to the xds Matcher type

Description:

In the extension matcher docs, the documentation generator doesn't generate a reference link for the xds.type.matcher.v3.Matcher.

The actual sphinx doc looks like this. Note How there is no :ref: generated for the xds.type.matcher.v3.Matcher type:

.. code-block:: json

  {
    "matcher": "{...}",
    "xds_matcher": "{...}",
    "extension_config": "{...}"
  }

.. _envoy_v3_api_field_extensions.common.matching.v3.ExtensionWithMatcher.matcher:

matcher
  (:ref:`config.common.matcher.v3.Matcher <envoy_v3_api_msg_config.common.matcher.v3.Matcher>`) The associated matcher. This is deprecated in favor of xds_matcher.
  
  
.. _envoy_v3_api_field_extensions.common.matching.v3.ExtensionWithMatcher.xds_matcher:

xds_matcher
  (.xds.type.matcher.v3.Matcher) The associated matcher.
  
  
.. _envoy_v3_api_field_extensions.common.matching.v3.ExtensionWithMatcher.extension_config:

extension_config
  (:ref:`config.core.v3.TypedExtensionConfig <envoy_v3_api_msg_config.core.v3.TypedExtensionConfig>`, *REQUIRED*) The underlying extension config.
  
 

Guide contributeur