rust-pip icon indicating copy to clipboard operation
rust-pip copied to clipboard

Add a documentation generating CI job

Open John15321 opened this issue 2 years ago • 0 comments

Add a CI job that generates documentation that we have stored in our project and produces some readable format that can be either downloaded or publish as a web page. Rust has two types of documentation:

  • The API documentation which is something you can read on creates.io
  • A Rust Book for a given project that is a more abstract representation of a project and usually has some guides, tutorials etc

Blocked by:

  • https://github.com/John15321/rust-pip/issues/34
  • https://github.com/John15321/rust-pip/issues/33
  • https://github.com/John15321/rust-pip/issues/32
  • https://github.com/John15321/rust-pip/issues/31
  • https://github.com/John15321/rust-pip/issues/30

John15321 avatar Aug 15 '22 21:08 John15321