Skip to content

Latest commit

 

History

History
35 lines (31 loc) · 829 Bytes

CONTRIBUTING.md

File metadata and controls

35 lines (31 loc) · 829 Bytes

Contributing

Documentation

Documentation hot reloading on file changes can be run in the background using cargo watch.

Setup

cargo install cargo-watch

Run

cargo watch \
  -w authzen \
  -w core \
  -w authz-engines \
  -w proc-macro-util \
  -w proc-macros \
  -w service-util \
  -w session \
  -w data-sources \
  -w Cargo.toml \
  -- \
  cargo +nightly doc --workspace --no-deps --all-features

Build

To generate the docs, cd into the root of the repository and run:

cargo +nightly doc --workspace --no-deps --all-features --verbose --color always
echo "<meta http-equiv=\"refresh\" content=\"0; url=authzen\">" > target/doc/index.html
rm -rf docs
mkdir docs
find target/doc -mindepth 1 -maxdepth 1 | sed "s:target/doc/::g" | xargs -n 1 -I {} sh -c "mv target/doc/{} docs/{}"