Skip to content

Online documentation #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
Boddlnagg opened this issue Jul 15, 2016 · 5 comments · Fixed by #82
Closed

Online documentation #14

Boddlnagg opened this issue Jul 15, 2016 · 5 comments · Fixed by #82

Comments

@Boddlnagg
Copy link
Collaborator

The AppVeyor build (see #13) can automatically run rustdoc (probably cargo doc --no-deps is best, because we don't want docs for winapi included) and upload the documentation to GitHub pages (gh-pages branch).
@Boddlnagg
Copy link
Collaborator Author

I just built a full documentation (--features all), it took a little over 10 minutes to build and resulted in about 300 MB of docs (the HTML version of the gen.rs source file is 65 MB alone).

I have no idea if that is going to be a problem.

@Boddlnagg
Copy link
Collaborator Author

This might not be needed now that https://docs.rs/ is a thing. We just need to make sure that documentation is built with --features all.

@Boddlnagg
Copy link
Collaborator Author

The documentation (without --features all) is available: https://docs.rs/winrt/*/x86_64-pc-windows-msvc/winrt/

I have added the link to README.md and Cargo.toml. Concerning the feature flag, see https://github.com/onur/docs.rs/issues/29

@Boddlnagg Boddlnagg changed the title Build documentation and upload to GitHub pages Online documentation Oct 2, 2016
@Boddlnagg
Copy link
Collaborator Author

Passing --features all is now supported on docs.rs, and implemented in a branch. I want to wait for https://github.com/onur/docs.rs/issues/135 before landing this, however.

@frewsxcv
Copy link

Following up from the previous comment, here's an updated link: rust-lang/docs.rs#135

MaulingMonkey added a commit to MaulingMonkey/winrt-rust that referenced this issue Jul 7, 2019
@MaulingMonkey
Make docs.rs show all features.
c7e515e 
winapi already does similar, and nobody objected in the discord ops/docs-rs channel.

Fixes contextfree#14
@MaulingMonkey MaulingMonkey mentioned this issue Jul 7, 2019
Merged
Boddlnagg pushed a commit that referenced this issue Jul 8, 2019
@MaulingMonkey @Boddlnagg
Make docs.rs show all features.
105b6e9 
winapi already does similar, and nobody objected in the discord ops/docs-rs channel.

Fixes #14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Make docs.rs show all features. MaulingMonkey/winrt-rust
2 participants
@frewsxcv @Boddlnagg