Skip to content

Commit

Permalink
Update apidocs.fsx
Browse files Browse the repository at this point in the history
  • Loading branch information
dsyme authored Nov 11, 2021
1 parent 57b5f89 commit 2c93118
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/apidocs.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -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
<PropertyGroup>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>
```
## Templates
The HTML is built by instantiating a template. The template used is the first of:
Expand Down

0 comments on commit 2c93118

Please sign in to comment.