Skip to content
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.

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

Enable all features for docs.rs generation #2687

Closed
wants to merge 1 commit into from
Closed

Enable all features for docs.rs generation #2687

wants to merge 1 commit into from

Conversation

GuillaumeGomez
Copy link
Contributor

The current docs.rs documentation for the windows-rs crate is useless currently: https://docs.rs/windows/latest/windows/

This enables all features so docs for all items will be available.

@GuillaumeGomez
Copy link
Contributor Author

Once merged, could you make a new release so we can have access to the documentation? Thanks in advance!

@tim-weis
Copy link
Contributor

This enables all features so docs for all items will be available.

Is docs.rs ready to deliver? Documentation for the windows crate is hosted here because docs.rs wasn't quite up for the task. Has the situation changed since?

@GuillaumeGomez
Copy link
Contributor Author

What was the issue? It took too long to generate the docs and it timed out?

@tim-weis
Copy link
Contributor

I do not recall the precise issues, but I believe it was either one of "too long" or "too much memory".

@GuillaumeGomez
Copy link
Contributor Author

Let me check with my docs.rs teammates to see if we can give it another try.

@kennykerr
Copy link
Collaborator

kennykerr commented Oct 20, 2023

See #420 #614 #851

I think the sticking point was that rustdoc consumed close to 20GB of memory to generate the docs.

@GuillaumeGomez
Copy link
Contributor Author

So the current blocker is the maximum memory from what I could infer. For that, we'll have to wait until the problem is solved in docs.rs.

In the meantime, would it be possible to add a links to the documentation of your crate so people (like me) actually can discover where it's used?

@kennykerr
Copy link
Collaborator

I think that's what #2297 by @ChrisDenton was meant to solve but I don't see the "stub" message here:

https://docs.rs/windows/latest/windows/

So perhaps something's not quite working.

@kennykerr kennykerr closed this Oct 20, 2023
@kennykerr
Copy link
Collaborator

@GuillaumeGomez feel free to tweak #2297 if there's something you know that we don't. 😀

@GuillaumeGomez
Copy link
Contributor Author

No I really meant in your documentation directly. I wasn't even aware of this link like one minute ago (and I'm in the docs.rs team XD).

@ChrisDenton
Copy link
Collaborator

The intent was to display a link in the documentation but only when published on docs.rs. I think I screwed up #2297 by using rustc-args instead of rustdoc-args.

@GuillaumeGomez
Copy link
Contributor Author

Ah yes indeed. Good catch! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants