Commit da956a85 authored by DJOUNANG NANA Guy Rostan's avatar DJOUNANG NANA Guy Rostan
Browse files

chore: Update README.md by taking into account review remarks

parent c2a3dbbc
Loading
Loading
Loading
Loading
+3 −3
Original line number Diff line number Diff line
## Objective

Cargo_doc aims to generate rustdoc for your project
Build a package's documentation for your project. Check the doc here 👉 [cargo-doc](https://doc.rust-lang.org/cargo/commands/cargo-doc.html#exit-status)

## How to use it

1. <Your steps>
1. Ensure that your project has Cargo.toml manifest.
1. Add this job URL inside the `include` list of your `.gitlab-ci.yml` file (see the [quick setup](/use-the-hub/#quick-setup)). You can specify [a fixed version](#changelog) instead of `latest`.
    ```yaml
      - remote: 'https://jobs.r2devops.io/latest/cargo_doc.yml'
@@ -27,6 +27,6 @@ Cargo_doc aims to generate rustdoc for your project
| ---- | ----------- | ------- |
| ONLY_LIB | Generate documentation of current library only | `false` | 
| PROJECT_ROOT | Relative to root of your repository, it is the path to your rust project | `.` | 
| RELEASE_MODE | Generate documentation with optimization for release | `true` | 
| RELEASE_MODE | Generate documentation with optimization for release. See the release profile here [release profile](https://doc.rust-lang.org/cargo/reference/profiles.html#release) | `true` | 
| OUTPUT_FOLDER | Directory where are output files | `website_build` | 
| ADDITIONAL_OPTIONS | Possibility to add more options into the command | ` ` |