envoyproxy/envoy

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

Open

#18,154 建立於 2021年9月17日

在 GitHub 查看
 (5 留言) (0 反應) (1 負責人)C++ (5,373 fork)batch import
area/docsbughelp wantedno stalebot

倉庫指標

Star
 (27,997 star)
PR 合併指標
 (平均合併 8天) (30 天內合併 378 個 PR)

描述

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.
  
 

貢獻者指南