Skip to content

Commit 9a89795

Browse files
author
davidbritch
committed
Initialize Docs repository: https://github.com/dotnet/android-api-docs of branch main
1 parent 7e724d5 commit 9a89795

File tree

4 files changed

+216
-1
lines changed

4 files changed

+216
-1
lines changed

‎.openpublishing.publish.config.json‎

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,51 @@
11
{
2-
"docsets_to_publish": [],
2+
"docsets_to_publish": [
3+
{
4+
"docset_name": "dotnet-android-api-docs",
5+
"build_source_folder": "docs",
6+
"build_output_subfolder": "dotnet-android-api-docs",
7+
"locale": "en-us",
8+
"monikers": [],
9+
"moniker_ranges": [],
10+
"open_to_public_contributors": true,
11+
"type_mapping": {
12+
"Conceptual": "Content",
13+
"ManagedReference": "Content",
14+
"NetEnum": "Content",
15+
"NetDelegate": "Content",
16+
"NetNamespace": "Content",
17+
"NetMember": "Content",
18+
"NetType": "Content"
19+
},
20+
"build_entry_point": "docs",
21+
"template_folder": "_themes",
22+
"base_path": "dotnet",
23+
"site_name": "Docs",
24+
"customized_tasks": {
25+
"docset_prebuild": [
26+
"_dependentPackages/ECMA2Yaml/tools/Run.ps1",
27+
"_dependentPackages/CommonPlugins/tools/SplitTOC.ps1",
28+
"_dependentPackages/CommonPlugins/tools/DiffFolder.ps1"
29+
],
30+
"docset_postbuild": [
31+
"_dependentPackages/ECMA2Yaml/tools/PostBuild.ps1"
32+
]
33+
},
34+
"ECMA2Yaml": {
35+
"SourceXmlFolder": "dotnet/xml",
36+
"OutputYamlFolder": "dotnet/api",
37+
"Flatten": true,
38+
"id": "dotnet-template",
39+
"SDPMode": true
40+
},
41+
"SplitTOC": [
42+
"dotnet/api/dotnet-template/toc.yml"
43+
],
44+
"DiffFolder": [
45+
"dotnet/api"
46+
]
47+
}
48+
],
349
"notification_subscribers": [],
450
"sync_notification_subscribers": [],
551
"branches_to_filter": [],

‎docs/breadcrumb/toc.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- name: Docs
2+
tocHref: /

‎docs/docfx.json‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
{
2+
"build": {
3+
"markdownEngineName": "markdig",
4+
"content": [
5+
{
6+
"files": [
7+
"**/*.md",
8+
"**/*.yml"
9+
],
10+
"exclude": [
11+
"**/obj/**",
12+
"**/includes/**",
13+
"**/_themes/**",
14+
"api/overwrites/**",
15+
"README.md",
16+
"LICENSE",
17+
"LICENSE-CODE",
18+
"ThirdPartyNotices"
19+
]
20+
}
21+
],
22+
"resource": [
23+
{
24+
"files": [
25+
"**/*.png",
26+
"**/*.jpg",
27+
"**/*.svg",
28+
"**/*.gif",
29+
"**/*.bmp"
30+
],
31+
"exclude": [
32+
"**/obj/**",
33+
"**/includes/**"
34+
]
35+
}
36+
],
37+
"overwrite": {
38+
"files": [
39+
"api/overwrites/**/*.md"
40+
]
41+
},
42+
"globalMetadata": {
43+
"apiPlatform": "dotnet",
44+
"breadcrumb_path": "~/breadcrumb/toc.yml",
45+
"feedback_system": "Standard"
46+
},
47+
"fileMetadata": {
48+
"author": {
49+
"api/**.yml": "dotnet-bot"
50+
}
51+
},
52+
"template": [],
53+
"isCanonicalUrlWithMoniker": true,
54+
"dest": "_site",
55+
"lruSize": 0
56+
}
57+
}

‎docs/xml/_filter.xml‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<filter>
3+
<attributeFilter apply="true">
4+
<!-- Most attributes in System.ComponentModel control designer behavior. Don't show them. -->
5+
<!-- The exceptions are attributes relating to data binding. Do show them. -->
6+
<namespaceFilter name="System.ComponentModel">
7+
<typeFilter name="BindableAttribute" expose="true" />
8+
<typeFilter name="BrowsableAttribute" expose="true" />
9+
<typeFilter name="ComplexBindingPropertiesAttribute" expose="true" />
10+
<typeFilter name="DataObjectAttribute" expose="true" />
11+
<typeFilter name="DefaultBindingPropertyAttribute" expose="true" />
12+
<typeFilter name="ListBindableAttribute" expose="true" />
13+
<typeFilter name="LookupBindingPropertiesAttribute" expose="true" />
14+
<typeFilter name="SettingsBindableAttribute" expose="true" />
15+
<typeFilter name="TypeConverterAttribute" expose="true" />
16+
<typeFilter name="*" expose="false" />
17+
</namespaceFilter>
18+
<namespaceFilter name="System.ComponentModel.Design">
19+
<typeFilter name="*" expose="false" />
20+
</namespaceFilter>
21+
<namespaceFilter name="System.ComponentModel.Design.Serialization">
22+
<typeFilter name="*" expose="false" />
23+
</namespaceFilter>
24+
<!-- Most attributes in System.Diagnostics control debugger behavior. Don't show them. -->
25+
<namespaceFilter name="System.Diagnostics">
26+
<typeFilter name="ConditionalAttribute" expose="true" />
27+
<typeFilter name="EventLogPermissionAttribute" expose="true" />
28+
<typeFilter name="PerformanceCounterPermissionAttribute" expose="true" />
29+
<typeFilter name="*" expose="false" />
30+
</namespaceFilter>
31+
<!-- Attributes in System.Diagnostics.CodeAnalysis control interaction with FxCop. Don't show them. -->
32+
<namespaceFilter name="System.Diagnostics.CodeAnalysis">
33+
<typeFilter name="*" expose="false" />
34+
</namespaceFilter>
35+
<!-- Attributes in System.EnterpriseServices control obscure details of COM+ interop. Don't show them. -->
36+
<namespaceFilter name="System.EnterpriseServices">
37+
<typeFilter name="*" expose="false" />
38+
</namespaceFilter>
39+
<!-- The DefaultMember attribute is usually compiler-generated. Users will see it from the member syntax. -->
40+
<namespaceFilter name="System.Reflection">
41+
<typeFilter name="DefaultMemberAttribute" expose="false" />
42+
<typeFilter name="*" expose="true" />
43+
</namespaceFilter>
44+
<!-- Attributes in System.Runtime.CompilerServices control obscure details of compilation. Don't show them. -->
45+
<namespaceFilter name="System.Runtime.CompilerServices">
46+
<typeFilter name="ExtensionAttribute" expose="true" />
47+
<typeFilter name="*" expose="false" />
48+
</namespaceFilter>
49+
<!-- Attributes in System.Runtime.ConstrinedExecution control obscure details of compilation. Don't show them. -->
50+
<namespaceFilter name="System.Runtime.ConstrainedExecution">
51+
<typeFilter name="*" expose="false" />
52+
</namespaceFilter>
53+
<!-- Most attributes in System.Runtime.InteropServices control obscure details of COM interop. Don't show them. -->
54+
<namespaceFilter name="System.Runtime.InteropServices">
55+
<typeFilter name="ComVisibleAttribute" expose="true" />
56+
<typeFilter name="GuidAttribute" expose="true" />
57+
<typeFilter name="ClassInterfaceAttribute" expose="true" />
58+
<typeFilter name="InterfaceTypeAttribute" expose="true" />
59+
<typeFilter name="*" expose="false" />
60+
</namespaceFilter>
61+
<!-- Attributes in System.Runtime.Versioning control details of resource loading. Don't show them. -->
62+
<namespaceFilter name="System.Runtime.Versioning">
63+
<typeFilter name="*" expose="false" />
64+
</namespaceFilter>
65+
<!-- Attributes in System.Security might hint as security implementation details. Don't show them. -->
66+
<namespaceFilter name="System.Security">
67+
<typeFilter name="SecurityCriticalAttribute" expose="true" />
68+
<typeFilter name="SecurityTreatAsSafeAttribute" expose="true" />
69+
<typeFilter name="AllowPartiallyTrustedCallersAttribute" expose="true" />
70+
<typeFilter name="*" expose="false" />
71+
</namespaceFilter>
72+
<!-- Attributes in System.Web.Compilation control interaction with the Expression designer. Don't show them. -->
73+
<namespaceFilter name="System.Web.Compilation">
74+
<typeFilter name="*" expose="false" />
75+
</namespaceFilter>
76+
<!-- The ASP.NET team only wants these attributes exposed from their namespace. Their logic ecscapes me, but here it is. -->
77+
<namespaceFilter name="System.Web.UI">
78+
<typeFilter name="ControlValuePropertyAttribute" expose="true" />
79+
<typeFilter name="PersistenceModeAttribute" expose="true" />
80+
<typeFilter name="ValidationPropertyAttribute" expose="true" />
81+
<typeFilter name="WebResourceAttribute" expose="true" />
82+
<typeFilter name="TemplateContainerAttribute" expose="true" />
83+
<typeFilter name="ThemeableAttribute" expose="true" />
84+
<typeFilter name="TemplateInstanceAttribute" expose="true" />
85+
<typeFilter name="*" expose="false" />
86+
</namespaceFilter>
87+
<!-- Don't show attributes related to XAML serialization details. -->
88+
<namespaceFilter name="System.Windows.Markup">
89+
<typeFilter name="ConstructorArgumentAttribute" expose="false" />
90+
<typeFilter name="DesignerSerializationOptionsAttribute" expose="false" />
91+
<typeFilter name="ValueSerializerAttribute" expose="false" />
92+
<typeFilter name="XmlnsCompatibleWithAttribute" expose="false" />
93+
<typeFilter name="XmlnsDefinitionAttribute" expose="false" />
94+
<typeFilter name="XmlnsPrefixAttribute" expose="false" />
95+
<typeFilter name="*" expose="true" />
96+
</namespaceFilter>
97+
<!-- Attributes in System.Xml.Serialization control obscure details of XML serialization. Don't show them.-->
98+
<namespaceFilter name="System.Xml.Serialization">
99+
<typeFilter name="*" expose="false" />
100+
</namespaceFilter>
101+
<!-- The GeneratedCodeAttribute is useful only to tools, and should be hidden from end users.-->
102+
<namespaceFilter name="System.CodeDom.Compiler">
103+
<typeFilter name="GeneratedCodeAttribute" expose="false" />
104+
<typeFilter name="*" expose="true" />
105+
</namespaceFilter>
106+
<namespaceFilter name="*">
107+
<typeFilter name="*" expose="true" />
108+
</namespaceFilter>
109+
</attributeFilter>
110+
</filter>

0 commit comments

Comments
 (0)