Skip to content

API Filtering Yml Cannot Include Specific Namespace #9404

@groogiam

Description

@groogiam

Describe the bug
The api filtering yml mechanism does not allow keeping a specific sub namespace as per https://dotnet.github.io/docfx/docs/dotnet-api-docs.html#filter-by-uid.

To Reproduce
Steps to reproduce the behavior:

The following api rules yml does filters out all items in the MyProject.Server namespace.

apiRules:
- include:
    uidRegex: ^MyProject\.Server\.Config
- exclude:
    uidRegex: ^MyProject\.Server

Expected behavior
Based on the documentation this should generate docs for only MyProject.Server.Config

It seems like the excludes are taking precedence over the includes.

Context (please complete the following information):

  • OS: Windows 10 Pro
  • Docfx version: 2.73.1+1d7b96c23465e14eafbcb0dd765029a87b5312d4

Metadata

Metadata

Assignees

No one assigned

    Labels

    dotnet: api-filterFilter APIs for .NET API reference docs

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions