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

Verify documentation links on Travis #82

Open
ghost opened this issue Aug 19, 2019 · 0 comments
Open

Verify documentation links on Travis #82

ghost opened this issue Aug 19, 2019 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers mentored Issues where we provide mentoring

Comments

@ghost
Copy link

ghost commented Aug 19, 2019

Let's use cargo-deadlinks with the following command on Travis:

cargo deadlinks --check-http

This currently fails with some errors which are due to re-exports from std:

Found invalid urls in /home/stjepang/work/async-std/target/doc/async_std/io/type.Result.html:
        Linked file at path /home/stjepang/work/async-std/target/doc/async_std/result/enum.Result.html does not exist!
Found invalid urls in /home/stjepang/work/async-std/target/doc/async_std/io/struct.Error.html:
        Linked file at path /home/stjepang/work/async-std/target/doc/std/io/struct.Error.html does not exist!
        Linked file at path /home/stjepang/work/async-std/target/doc/std/io/enum.ErrorKind.html does not exist!
        Linked file at path /home/stjepang/work/async-std/target/doc/async_std/ffi/struct.NulError.html does not exist!

The way we resolve these errors is by writing shim docs for re-exports from std, similarly to how we did that here:

if #[cfg(feature = "docs")] {

The idea is that under the docs feature flag we generate "fake" docs linking to async-std's types, but otherwise re-export real types from std.

@ghost ghost added documentation Improvements or additions to documentation good first issue Good for newcomers mentored Issues where we provide mentoring labels Aug 19, 2019
@ghost ghost mentioned this issue Aug 20, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers mentored Issues where we provide mentoring
Projects
None yet
Development

Successfully merging a pull request may close this issue.

0 participants