我正在使用 DocFx 生成有关 WCF Web 服务的文档。文档的目标受众是 Web 服务的客户。这些客户端显然无法直接访问 .NET 二进制文件。
公共接口和模型以及它们的方法和属性的文档很重要,但是还有很多与客户端无关的其他信息:
- 工具
- 继承成员
- 集会
- 句法
- 构造函数
要清楚 - 我不想过滤掉某些类型或成员(如此处所述) - 我想过滤掉所有类型的文档的整个部分。
您可以通过覆盖模板来自定义输出。
就我而言,我assembly
通过以下方式从课程页面中删除了该部分。
docfx template export default
。_exported_templates/default/partials/class.header.tmpl.partial
到DOCFX_PROJECT_ROOT/templates/custom/partial
.build
部分中docfx.json
,将其编辑template
为以下内容"template": [
"default",
"templates/custom"
],
您现在可以通过类似docfx docfx.json
.
我相信您提到的其他部分可以通过编辑和复制模板目录中的相应文件来删除。
如何隐藏继承的成员:
添加
.inheritedMembers { display: none; }
到“_site\styles\main.css”