How to Generate .NET API Documentation

Roslynator CLI allows you to generate documentation for .NET library.

Documentation can be published to following hosts:

• Docusaurus
• GitHub
• Sphinx

Generate Documentation Files

Run following command to generate documentation:

roslynator generate-doc

Usage

generate-doc-files.ps1

roslynator generate-doc MY_SOLUTION.sln `
 --properties Configuration=Release `
 -o "build/ref" `
 --host docusaurus `
 --heading ".NET API Reference" `
 --group-by-common-namespace `
 --ignored-common-parts content `
 --ignored-root-parts all `
 --max-derived-types 10

Generate Documentation Root File

Run following command to generate documentation root file:

roslynator generate-doc-root

Usage

generate-doc-root-file.ps1

roslynator generate-doc-root MY_SOLUTION.sln `
 --properties Configuration=Release `
 -o "build/ref.md" `
 --host docusaurus `
 --heading ".NET API Reference" `
 --ignored-parts content `
 --root-directory-url "ref"

See the actual script.