Skip to content
This repository has been archived by the owner on May 1, 2024. It is now read-only.

Generate API documentation with mdoc

Jump to bottom
Gerald Versluis edited this page Mar 3, 2021 · 1 revision

This page is mostly for maintainers, because I am sure to forget some of this over time :D

Generate API docs

  1. Clone the latest and greatest of the current stable release
  2. Run msbuild Xamarin.CommunityToolkit.All.sln /t:restore,build,MDocUpdateDocs /p:GenerateApiDocs=true /p:Configuration=Release. This builds both the Toolkit and Markup projects, pulls together all the references and Toolkit/Markup assemblies in {repo root}/docs and starts generating all the documentation XML files in {repo root}/docs/en
  3. Copy all the XML files to xamarin-community-toolkit-api-docs/xml of this repo and make sure xml/_filter.xml and xml/PackageInformation (folder) stay in the same place, the rest of the files can be deleted to make sure everything is fully refreshed if needed
  4. Update the version number of the Toolkit in the xml/PackageInformation/xamarin-community-toolkit-sdk.json file
  5. Put the result in a branch and open a PR on the repo
Clone this wiki locally