dotnet / dotnet/docfx

Removing "Field" section from docfx generated pages

Open
#8,875 0 comments 0 reactions 0 assignees View on GitHub
dotnet dotnet: api-filter
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 9m
Merged PRs (30d)
11

Description

I have generated documentation of a .NET API and want to remove the "Field"(i.e. protected data items) section from the generated docs. I have used API filters to remove the Field section but the problem is, it removes the methods as well along with the Field section.
I defined the apiRules inside filterConfig.yml file and linked into docfx.json file.

Following are the API rules:
apiRules:
- exclude:
uidRegex: ^System\.Apple
type: Field

**Context (please complete the following information):**
- OS: macOS
- Docfx version: 2.59.2.0
- .NET version: 7.0.302

- `docfx.json` config

This is how I linked filterConfig.yml file.
"metadata": [
{
"src": [
{
"files": [
"src/**.csproj"
]
}
],
"dest": "api",
"filter": "filterConfig.yml",
"disableGitFeatures": false,
"disableDefaultFilter": false
}
],
```

**Additional context**
Please help me to remove just the "Field" section from the generated pages. Thanks

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.