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

Test that cargo doc runs successfully in CI #67

Closed
Anders429 opened this issue Mar 17, 2022 · 0 comments · Fixed by #69
Closed

Test that cargo doc runs successfully in CI #67

Anders429 opened this issue Mar 17, 2022 · 0 comments · Fixed by #69
Labels
C - Documentation Category: Improvements or additions to documentation.

Comments

@Anders429
Copy link
Owner

We should check that cargo doc runs successfully in CI, promoting all warnings to errors using the RUSTDOCFLAGS='-D warnings' env variable (see this issue for discussion on using this env variable). Ideally, we should also attempt to build documentation in as close to the same way as what docs.rs will be doing. This should hopefully prevent having to republish due to failures occurring in docs.rs generating documentation.

@Anders429 Anders429 added the C - Documentation Category: Improvements or additions to documentation. label Mar 17, 2022
This was referenced Mar 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C - Documentation Category: Improvements or additions to documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant