bec6ba088d | ||
---|---|---|
docs | ||
.gitattributes | ||
.gitignore | ||
LICENSE | ||
SECURITY.md | ||
code_of_conduct.md | ||
readme.md |
readme.md
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:
-
Delete everything in
windows-docs-rs/docs
except:index.html
,header.html
,.nojekyll
, andopensearch.xml
. -
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
-
Delete everything in
windows-docs-rs/docs
exceptindex.html
,header.html
,.nojekyll
,opensearch.xml
, anddoc
-
Run
git add .
followed bygit commit -am "<next version>"