Skip to content

Commit d36cdf5

Browse files
committed
Support override files for docs
1 parent 89d5e6e commit d36cdf5

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

ChartTools/ChartTools.Generator/MetadataMapGenerator.cs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,7 @@
1111

1212
namespace ChartTools.Generator;
1313

14-
/// <summary>
15-
/// Generates mapping methods between <see cref="Metadata"/> properties and their corresponding keys in different file formats, as defined by <see cref="MetadataKeyAttribute"/>
16-
/// </summary>
14+
/// <exclude />
1715
[Generator]
1816
public class MetadataMapGenerator : IIncrementalGenerator
1917
{

ChartTools/Docs/apidocs/README.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Use this directory to override sections of the Api Documentation with custom markdown instead of referring to the xml tag in the code. Use this to provide code examples and embed partial usage documentation. Include links to relevant Articles.
2+
3+
See https://github.com/dotnet/docfx/blob/main/docs/tutorial/intro_overwrite_files.md

ChartTools/Docs/docfx.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
}
1111
],
1212
"dest": "api",
13-
"namespaceLayout": "nested"
13+
"namespaceLayout": "nested"
1414
}
1515
],
1616
"build": {
@@ -21,10 +21,12 @@
2121
],
2222
"exclude": [
2323
"_site/**",
24-
"obj/**"
24+
"obj/**",
25+
"apidocs/**"
2526
]
2627
}
2728
],
29+
"overwrite": "apidocs/*.md",
2830
"resource": [
2931
{
3032
"files": [

0 commit comments

Comments
 (0)