dotnet / dotnet/docfx

How to selectively compile API documents?

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

Description

Hi,
I am trying to generate Api Document by using the configuration below. However, my solution has to many .csproj files, and that causes me too much time when I am running the command "docfx project/docfx.json". Is there any way to selectively compile API documents?

like this:
the first time to run "docfx project/docfx.json" generate api documents .
the second time to run "docfx project/docfx.json --other/commend" do not “compile” API document(cause me too much time to generate the website). the api documents first time generated are still in the website.

Any insights would be greatly appreciated!

Thanks,

{
"metadata": [
{
"src": [
{
"files": [
"src/3.0/src/MyProduct/**.sln"
]
}
],
"dest": "api",
"disableGitFeatures": false,
"disableDefaultFilter": false,
},
"build": {
"content": [
{
"files": [
"api/**.yml",
"api/index.md"
]
},
{
"files": [
"articles/**.md",
"articles/**/toc.yml",
"toc.yml",
"*.md"
]
}
],
"resource": [
{
"files": [
"images/**"
]
}
],
"overwrite": [
{
"files": [
"apidoc/**.md"
],
"exclude": [
"obj/**",
"_site/**"
]
}
],
"dest": "_site",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
"default"
],
"postProcessors": [],
"markdownEngineName": "markdig",
"noLangKeyword": false,
"keepFileLink": false,
"cleanupCacheHistory": false,
"disableGitFeatures": false
}
}

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.