Skip to content

Rust docs for the Windows API

License

Notifications You must be signed in to change notification settings

microsoft/windows-docs-rs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

87 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Windows API documentation for Rust

This is an experimental documentation generator for the Rust for Windows project. The documentation is published here:

https://microsoft.github.io/windows-docs-rs/

It can be manually generated (using the nightly toolchain) as follows:

  1. Delete everything in windows-docs-rs/docs except: index.html, header.html, .nojekyll, and opensearch.xml.

  2. Run the following command from the windows-rs directory:

PowerShell:

PS C:\git\windows-rs> cargo --config "build.rustdocflags = [`"--html-in-header`", `"d:\\git\\windows-docs-rs\\docs\\header.html`"]" doc -p windows --all-features --no-deps --target-dir d:\git\windows-docs-rs\docs

Cmd:

C:\git\windows-rs> cargo --config "build.rustdocflags = [""--html-in-header"", ""d:\\git\\windows-docs-rs\\docs\\header.html""]" doc -p windows --all-features --no-deps --target-dir d:\git\windows-docs-rs\docs
  1. Delete everything in windows-docs-rs/docs except index.html, header.html, .nojekyll, opensearch.xml, and doc

  2. Run git add . followed by git commit -am "<next version>"