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 generating CI job #35

Open
John15321 opened this issue Aug 15, 2022 · 0 comments
Open

Add a documentation generating CI job #35

John15321 opened this issue Aug 15, 2022 · 0 comments
Labels
blocked CI/CD documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Milestone

Comments

@John15321
Copy link
Contributor

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:

@John15321 John15321 added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers CI/CD blocked labels Aug 15, 2022
@John15321 John15321 moved this to Todo in rust-pip Aug 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked CI/CD documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant