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

Doc: missing for some modules #235

Closed
unkcpz opened this issue Feb 24, 2025 · 4 comments
Closed

Doc: missing for some modules #235

unkcpz opened this issue Feb 24, 2025 · 4 comments

Comments

@unkcpz
Copy link
Contributor

unkcpz commented Feb 24, 2025

In https://docs.rs/keyring/latest/keyring/#modules, it only has the secret-service module where I can go and check the doc of credential description.
I was expect also the doc for the keyutils and for ios/macos.

I assume build-xplat-docs.sh is for building cross-platform doc. But the build OS is linux so the apple part is ignored.
I believe this is a more standard way to build doc with cross-platform doc?

@unkcpz unkcpz changed the title Doc are missing for some modules Doc: missing for some modules Feb 24, 2025
@brotskydotcom
Copy link
Collaborator

Hi Jusong, thanks for raising this question. Because I've assumed that people only need docs for the platforms they can actually build for, and because docs.rs builds for all the "common" platforms (including macOS, although not iOS), I've never thought about doing an "all-platforms" build of the doc. I would be happy to look at a PR if you're interested in providing one.

@unkcpz
Copy link
Contributor Author

unkcpz commented Feb 25, 2025

Thanks for quick reply. It is mostly for the python binding keyringrs you may notice through another issue I opened. I want to redirect from the readme to docs.rs for all platforms for options such as definition of target option of different platform.

I am surely willing to fire a PR. Could you tell me is build-xplot-docs.sh is used or it can replace with trying to use #[cfg(doc)].

@brotskydotcom
Copy link
Collaborator

The build-xplat-docs.sh file is just for local development purposes and should be removed as part of your PR. By all means try getting the docs working using #[cfg(doc)]

@unkcpz
Copy link
Contributor Author

unkcpz commented Feb 25, 2025

thanks, I draft a PR in #237, let's move the discussion there. It actually not trivial to make docs build for cross-platfrom, which regard as [the 'holy grail of rustdoc'](https://doc.rust-lang.org/rustdoc/advanced-features.html?search=dox) :)

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

No branches or pull requests

2 participants