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

Add a documentation build step to CI #83

Open
fjarri opened this issue Dec 19, 2021 · 0 comments
Open

Add a documentation build step to CI #83

fjarri opened this issue Dec 19, 2021 · 0 comments
Assignees
Labels
CI Continuous integration documentation Improvements or additions to documentation

Comments

@fjarri
Copy link
Contributor

fjarri commented Dec 19, 2021

Even though documentation is build automatically by docs.rs on release, it uses a non-standard environment to build docs, so it would be useful to check in a CI action that docs can be built correctly.

In particular:

  • it uses the nightly Rust
  • it uses a specific configuration flag (docsrs, see package.metadata.docs.rs section in Cargo.toml), which enables doc_cfg feature and corresponding doc() attributes
  • it uses specific features (also set in package.metadata.docs.rs section in Cargo.toml)

For more info see https://docs.rs/about/builds

@fjarri fjarri added documentation Improvements or additions to documentation CI Continuous integration labels Dec 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous integration documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants