-
-
Notifications
You must be signed in to change notification settings - Fork 55
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
Comments
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. |
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 I am surely willing to fire a PR. Could you tell me is |
The |
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) :) |
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?
The text was updated successfully, but these errors were encountered: