From 2c93118a9e3d2491803988ab32d752b1210c6f31 Mon Sep 17 00:00:00 2001 From: Don Syme Date: Thu, 11 Nov 2021 01:11:48 +0000 Subject: [PATCH] Update apidocs.fsx --- docs/apidocs.fsx | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/apidocs.fsx b/docs/apidocs.fsx index 6dcace0df..0ebbef309 100644 --- a/docs/apidocs.fsx +++ b/docs/apidocs.fsx @@ -37,6 +37,19 @@ The [command-line tool `fsdocs`](commandline.html) can be used to generate docum for F# libraries with XML comments. The documentation is normally built using `fsdocs build` and developed using `fsdocs watch`. For the former the output will be placed in `output\reference` by default. +## Selected projects + +`fsdocs` automatically selects the projects and "cracks" the project files for information + +* Projects with `GenerateDocumentationFile` and without `IsTestProject` are selected. +* Projects must not use `TargetFrameworks` (only `TargetFramework`, singular). + +```text + + true + +``` + ## Templates The HTML is built by instantiating a template. The template used is the first of: