dotnet / dotnet/docfx

List source dlls (metadata section in json file) in external file

Open
#3,879 2 comments 0 reactions 0 assignees View on GitHub
dotnet
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

**DocFX Version Used**: 2.40.7

**Template used**: default

**Problem statement**:

We use dlls as input for generating metadata. We only consider dlls that are part of our public platform API. This set of dlls changes over time. For better maintainability, we want to separate the dynamic part and the static part of the docfx.json file. That means, we would like to create a separate configuration file that lists all the dlls to be considered and we would like to reference this file within the docfx.json file (see Example below). **Is there any way to do so?**

_Example for Docfx.json File_

```
{
"metadata": [
{
"src": [
{
separateConfigurationFile.json
}
],
"dest": "api",
"disableGitFeatures": false,
"disableDefaultFilter": false
}
],

```

_Example for separateConfigurationFile.json File_

```
{
"src": "../../",
"files": [
"first.dll",
"second.dll",
"third.dll"
]
}
```

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.